OSID - osid.hold.BlockOublietteSession Service Interface Definition

Interface	osid.hold.BlockOublietteSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session provides methods to retrieve `Block` to `Oubliette` holds. A `Block` may appear in multiple `Oubliette` objects. Each oubliette may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupBlockOublietteMappings
Description	Tests if this user can perform lookups of block/oubliette holds. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBlockOublietteView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBlockOublietteView
Description	A complete view of the `Block` and `Oubliette` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getBlockIdsByOubliette
Description	Gets the list of `Block Ids` associated with an `Oubliette`.
Parameters	`osid.id.Id`	`oublietteId`	`Id` of the `Oubliette`
Return	`osid.id.IdList`		list of related block `Ids`
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBlocksByOubliette
Description	Gets the list of `Blocks` associated with an `Oubliette`.
Parameters	`osid.id.Id`	`oublietteId`	`Id` of the `Oubliette`
Return	`osid.hold.BlockList`		list of related blocks
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBlockIdsByOubliettes
Description	Gets the list of `Block Ids` corresponding to a list of `Oubliettes`.
Parameters	`osid.id.IdList`	`oublietteIds`	list of oubliette `Ids`
Return	`osid.id.IdList`		list of block `Ids`
Errors	NULL_ARGUMENT		`oublietteIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBlocksByOubliettes
Description	Gets the list of `Block` corresponding to a list of `Oubliettes`.
Parameters	`osid.id.IdList`	`oublietteIds`	list of oubliette `Ids`
Return	`osid.hold.BlockList`		list of blocks
Errors	NULL_ARGUMENT		`oublietteIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteIdsByBlock
Description	Gets the `Oubliette` `Ids` mapped to a `Block`.
Parameters	`osid.id.Id`	`blockId`	`Id` of a `Block`
Return	`osid.id.IdList`		list of oubliettes
Errors	NOT_FOUND		`blockId` is 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	getOubliettesByBlock
Description	Gets the `Oubliettes` mapped to a `Block`.
Parameters	`osid.id.Id`	`blockId`	`Id` of a `Block`
Return	`osid.hold.OublietteList`		list of oubliettes
Errors	NOT_FOUND		`blockId` is not found
	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.