OSID - osid.hold.HoldSearchSession Service Interface Definition

Interface	osid.hold.HoldSearchSession
Implements	`osid.hold.HoldQuerySession`
Description	This session provides methods for searching among `Hold` objects. The search query is constructed using the `HoldQuery.` `getHoldsByQuery()` is the basic search method and returns a list of `Holds.` A more advanced search may be performed with `getHoldsBySearch().` It accepts a `HoldSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getHoldsBySearch()` returns a `HoldSearchResults` that can be used to access the resulting `HoldList` or be used to perform a search within the result set through `HoldSearch.` 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	getHoldSearch
Description	Gets a hold search.
Return	`osid.hold.HoldSearch`		the hold search
Compliance	`mandatory`		This method must be implemented.
Method	getHoldSearchOrder
Description	Gets a hold search order. The `HoldSearchOrder` is supplied to a `HoldSearch` to specify the ordering of results.
Return	`osid.hold.HoldSearchOrder`		the hold search order
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.HoldQuery`	`holdQuery`	the hold query
Parameters	`osid.hold.HoldSearch`	`holdSearch`	the hold search
Return	`osid.hold.HoldSearchResults`		the hold search results
Errors	NULL_ARGUMENT		`holdQuery` or `holdSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdQuery` or `holdSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getHoldQueryFromInspector
Description	Gets a hold query from an inspector. The inspector is available from a `HoldSearchResults.`
Parameters	`osid.hold.HoldQueryInspector`	`holdQueryInspector`	a hold query inspector
Return	`osid.hold.HoldQuery`		the hold query
Errors	NULL_ARGUMENT		`holdQueryInspector` is `null`
Errors	UNSUPPORTED		`holdQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.