OSID - osid.lexicon.PressAdminSession Service Interface Definition

Interface	osid.lexicon.PressAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.lexicon.batch.PressBatchAdminSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session creates, updates, and deletes `Presses`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Press`, a `PressForm` is requested using `getPressFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PressForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `PressForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PressForm` corresponds to an attempted transidiom. For updates, `PressForms` are requested to the `Press` `Id` that is to be updated using `getPressFormForUpdate()`. Similarly, the `PressForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PressForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Presses`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreatePresses
Description	Tests if this user can create `Presses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Press`. will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Press` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePressWithRecordTypes
Description	Tests if this user can create a single `Press` using the desired record types. While `LexiconManager.getPressRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Press`. Providing an empty array tests if a `Press` can be created with no records.
Parameters	`osid.type.Type[]`	`pressRecordTypes`	array of press record types
Return	`boolean`		`true` if `Press` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pressRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPressFormForCreate
Description	Gets the press form for creating new presses. A new form should be requested for each create transidiom.
Parameters	`osid.type.Type[]`	`pressRecordTypes`	array of press record types
Return	`osid.lexicon.PressForm`		the press form
Errors	NULL_ARGUMENT		`pressRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createPress
Description	Creates a new `Press`.
Parameters	`osid.lexicon.PressForm`	`pressForm`	the form for this `Press`
Return	`osid.lexicon.Press`		the new `Press`
Errors	ILLEGAL_STATE		`pressForm` already used in a create transidiom
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`pressForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pressForm` did not originate from `getPressFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePresses
Description	Tests if this user can update `Presses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Press` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Press` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPressFormForUpdate
Description	Gets the press form for updating an existing press. A new press form should be requested for each update transidiom.
Parameters	`osid.id.Id`	`pressId`	the `Id` of the `Press`
Return	`osid.lexicon.PressForm`		the press form
Errors	NOT_FOUND		`pressId` is not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePress
Description	Updates an existing press
Parameters	`osid.lexicon.PressForm`	`pressForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`pressForm` already used in an update transidiom
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`pressForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pressForm` did not originate from `getPressFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePresses
Description	Tests if this user can delete `Presses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Press` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Press` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePress
Description	Deletes a `Press`.
Parameters	`osid.id.Id`	`pressId`	the `Id` of the `Press` to remove
Errors	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePressAliases
Description	Tests if this user can manage `Id` aliases for `Presses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Press` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPress
Description	Adds an `Id` to a `Press` for the purpose of creating compatibility. The primary `Id` of the `Press` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.
Parameters	`osid.id.Id`	`pressId`	the `Id` of a `Press`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`pressId` not found
	NULL_ARGUMENT		`pressId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.