OSID - osid.hold.HoldQuerySession Service Interface Definition

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