OSID - osid.hold.BlockQuerySession Service Interface Definition

Interface	osid.hold.BlockQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.hold.BlockSearchSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session provides methods for searching among `Block` objects. The search query is constructed using the `BlockQuery`. This session defines views that offer differing behaviors for searching. federated oubliette view: searches include blocks in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to blocks in this oubliette Blocks may have a query record indicated by their respective record types. The query record is accessed via the `BlockQuery`.
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	canSearchBlocks
Description	Tests if this user can perform `Block` lookups. 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 search 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 blocks in oubliette 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 searches to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBlockQuery
Description	Gets a block query.
Return	`osid.hold.BlockQuery`		the block query
Compliance	`mandatory`		This method must be implemented.
Method	getBlocksByQuery
Description	Gets a list of `Blocks` matching the given block query.
Parameters	`osid.hold.BlockQuery`	`blockQuery`	the block query
Return	`osid.hold.BlockList`		the returned `BlockList`
Errors	NULL_ARGUMENT		`blockQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`blockQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.