OSID - osid.hold.rules.HoldEnablerQuerySession Service Interface Definition

Interface	osid.hold.rules.HoldEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.hold.rules.HoldEnablerSearchSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `HoldEnabler` objects. The search query is constructed using the `HoldEnablerQuery`. This session defines views that offer differing behaviors for searching. federated oubliette view: searches include hold enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to hold enablers in this oubliette Hold enablers may have a query record indicated by their respective record types. The query record is accessed via the `HoldEnablerQuery`.
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	canSearchHoldEnablers
Description	Tests if this user can perform `HoldEnabler` 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 hold enablers in oubliettes 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 lookups to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	getHoldEnablerQuery
Description	Gets a hold enabler query.
Return	`osid.hold.rules.HoldEnablerQuery`		the hold enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersByQuery
Description	Gets a list of `HoldEnablers` matching the given hold enabler query.
Parameters	`osid.hold.rules.HoldEnablerQuery`	`holdEnablerQuery`	the hold enabler query
Return	`osid.hold.rules.HoldEnablerList`		the returned `HoldEnablerList`
Errors	NULL_ARGUMENT		`holdEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.