OSID - osid.hold.BlockSession Service Interface Definition

Interface	osid.hold.BlockSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This is the basic session for checking blocks. isolated oubliette view: All issue methods in this session operate, retrieve and pertain to availabilities defined explicitly in the current oubliette. Using an isolated view is useful for managing `Availabilities` with the `IssueAdminSession`. federated oubliette view: All issue lookup methods in this session operate, retrieve and pertain to all availabilities defined in this oubliette and any other availabilities implicitly available in this oubliette through oubliette inheritence. The methods `useFederatedOublietteView()` and `useIsolatedOublietteView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canAccessBlocks
Description	Tests if this user can perform `Block` checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if block methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	isBlocked
Description	Determines if the given resource is blocked. A resource is blocked if an active `Hold` for the given agent exists for an `Issue` maped to the given `Block`.
Parameters	`osid.id.Id`	`agentId`	the `Id` of an `Agent`
Parameters	`osid.id.Id`	`blockId`	the `Id` of a `Block`
Return	`boolean`		`true` if the user is blocked, `false` othersise
Errors	NOT_FOUND		`blockId` is not found
	NULL_ARGUMENT		`agentId` or `blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure making request
Compliance	`mandatory`		This method must be implemented.