OSID - osid.provisioning.QueueSearchSession Service Interface Definition

Interface	osid.provisioning.QueueSearchSession
Implements	`osid.provisioning.QueueQuerySession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Queue` objects. The search query is constructed using the `QueueyQuery`. `getQueuesByQuery()` is the basic search method and returns a list of `Queues`. A more advanced search may be performed with `getQueuesBySearch()`. It accepts a `QueueSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQueuesBySearch()` returns a `QueueSearchResults` that can be used to access the resulting `QueueList` or be used to perform a search within the result set through `QueueSearch`. This session defines views that offer differing behaviors for searching. federated broker view: searches include queues in brokers of which this broker is an ancestor in the broker hierarchy isolated broker view: searches are restricted to queues in this broker Queues may have a queue record indicated by their respective record types. The queue record is accessed via the `QueueQuery`.
Method	getQueueSearch
Description	Gets a queue search.
Return	`osid.provisioning.QueueSearch`		the queue search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueSearchOrder
Description	Gets a queue search order. The `QueueSearchOrder` is supplied to a `QueueSearch` to specify the ordering of results.
Return	`osid.provisioning.QueueSearchOrder`		the queue search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueuesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.QueueQuery`	`queueQuery`	the queue query
Parameters	`osid.provisioning.QueueSearch`	`queueSearch`	the queue search
Return	`osid.provisioning.QueueSearchResults`		the queue search results
Errors	NULL_ARGUMENT		`queueQuery` or `queueSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueQuery` or `queueSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueQueryFromInspector
Description	Gets a queue query from an inspector. The inspector is available from a `QueueSearchResults`.
Parameters	`osid.provisioning.QueueQueryInspector`	`queueQueryInspector`	a queue query inspector
Return	`osid.provisioning.QueueQuery`		the queue query
Errors	NULL_ARGUMENT		`queueQueryInspector` is `null`
Errors	UNSUPPORTED		`queueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.