OSID - osid.hold.BlockSmartOublietteSession Service Interface Definition

Interface	osid.hold.BlockSmartOublietteSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `BlockQuery` can be retrieved from this session and mapped to this `Oubliette` to create a virtual collection of `Blocks`. The blocks may be sequenced using the `BlockSearchOrder` from this session. This `Oubliette` has a default query that matches any block and a default search order that specifies no sequencing. The queries may be examined using a `BlockQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartOubliettes
Description	Tests if this user can manage smart oubliettes. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart oubliette management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getBlockSearchOrder
Description	Gets a block search order.
Return	`osid.hold.BlockSearchOrder`		the block search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBlockQuery
Description	Applies a block query to this oubliette.
Parameters	`osid.hold.BlockQuery`	`blockQuery`	the block query
Errors	NULL_ARGUMENT		`blockQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`blockQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBlockQuery
Description	Gets a block query inspector for this oubliette.
Return	`osid.hold.BlockQueryInspector`		the block query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBlockSequencing
Description	Applies a block search order to this oubliette.
Parameters	`osid.hold.BlockSearchOrder`	`blockSearchOrder`	the block search order
Errors	NULL_ARGUMENT		`blockSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`blockSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBlockQueryFromInspector
Description	Gets a block query from an inspector.
Parameters	`osid.hold.BlockQueryInspector`	`blockQueryInspector`	a block query inspector
Return	`osid.hold.BlockQuery`		the block query
Errors	NULL_ARGUMENT		`blockQueryInspector` is `null`
Errors	UNSUPPORTED		`blockQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.