OSID - osid.hold.BlockAdminSession Service Interface Definition

Interface	osid.hold.BlockAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Blocks.` 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 `Block,` a `BlockForm` is requested using `getBlockFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `BlockForm` 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 `BlockForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BlockForm` corresponds to an attempted transaction. For updates, `BlockForms` are requested to the `Block` `Id` that is to be updated using `getBlockFormForUpdate().` Similarly, the `BlockForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BlockForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Blocks.` To unmap a `Block` from the current `Oubliette,` the `BlockOublietteAssignmentSession` should be used. These delete operations attempt to remove the `Block` itself thus removing it from all known `Oubliette` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBlocks
Description	Tests if this user can create `Blocks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Block` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Block` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBlockWithRecordTypes
Description	Tests if this user can create a single `Block` using the desired record types. While `HoldManager.getBlockRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Block.` Providing an empty array tests if a `Block` can be created with no records.
Parameters	`osid.type.Type[]`	`blockRecordTypes`	array of block record types
Return	`boolean`		`true` if `Block` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`blockRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBlockFormForCreate
Description	Gets the block form for creating new blocks. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`blockRecordTypes`	array of block record types
Return	`osid.hold.BlockForm`		the block form
Errors	NULL_ARGUMENT		`blockRecordTypes` 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	createBlock
Description	Creates a new `Block.`
Parameters	`osid.hold.BlockForm`	`blockForm`	the form for this `Block`
Return	`osid.hold.Block`		the new `Block`
Errors	ILLEGAL_STATE		`blockForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`blockForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`blockForm` did not originate from `getBlockFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBlocks
Description	Tests if this user can update `Blocks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Block` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Block` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBlockFormForUpdate
Description	Gets the block form for updating an existing block. A new block form should be requested for each update transaction.
Parameters	`osid.id.Id`	`blockId`	the `Id` of the `Block`
Return	`osid.hold.BlockForm`		the block form
Errors	NOT_FOUND		`blockId` is not found
	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateBlock
Description	Updates an existing block.
Parameters	`osid.hold.BlockForm`	`blockForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`blockForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`blockId` or `blockForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`blockForm` did not originate from `getBlockFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBlocks
Description	Tests if this user can delete `Blocks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Block` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Block` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBlock
Description	Deletes a `Block.`
Parameters	`osid.id.Id`	`blockId`	the `Id` of the `Block` to remove
Errors	NOT_FOUND		`blockId` not found
	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBlockAliases
Description	Tests if this user can manage `Id` aliases for `Blocks.` 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 `Block` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBlock
Description	Adds an `Id` to a `Block` for the purpose of creating compatibility. The primary `Id` of the `Block` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another block, it is reassigned to the given block `Id.`
Parameters	`osid.id.Id`	`blockId`	the `Id` of a `Block`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`blockId` not found
	NULL_ARGUMENT		`blockId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.