OSID - osid.resourcing.AvailabilitySearchSession Service Interface Definition

Interface	osid.resourcing.AvailabilitySearchSession
Implements	`osid.resourcing.AvailabilityQuerySession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session provides methods for searching among `Availability` objects. The search query is constructed using the `AvailabilityQuery` . `getAvailabilitiesByQuery()` is the basic search method and returns a list of `Availabilities` . A more advanced search may be performed with `getAvailabilitiesBySearch()` .It accepts an `AvailabilitySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAvailabilitiesBySearch()` returns an `AvailabilitySearchResults` that can be used to access the resulting `AvailabilityList` or be used to perform a search within the result set through `AvailabilitySearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include availabilities in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to availabilities in this foundry Availabilitys may have a query record indicated by their respective record types. The query record is accessed via the `AvailabilityQuery` .
Method	getAvailabilitySearch
Description	Gets an availability search.
Return	`osid.resourcing.AvailabilitySearch`		the availability search
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitySearchOrder
Description	Gets an availability search order. The `AvailabilitySearchOrder` is supplied to an `AvailabilitySearch` to specify the ordering of results.
Return	`osid.resourcing.AvailabilitySearchOrder`		the availability search order
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.AvailabilityQuery`	`availabilityQuery`	the availability query
Parameters	`osid.resourcing.AvailabilitySearch`	`availabilitySearch`	the availability search
Return	`osid.resourcing.AvailabilitySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`availabilityQuery` or `availabilitySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityQuery` or `availabilitySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityQueryFromInspector
Description	Gets an availability query from an inspector. The inspector is available from an `AvailabilitySearchResults` .
Parameters	`osid.resourcing.AvailabilityQueryInspector`	`availabilityQueryInspector`	an availability query inspector
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Errors	NULL_ARGUMENT		`availabilityQueryInspector` is `null`
Errors	UNSUPPORTED		`availabilityQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.