OSID - osid.provisioning.rules.QueueConstrainerSearchSession Service Interface Definition

Interface	osid.provisioning.rules.QueueConstrainerSearchSession
Implements	`osid.provisioning.rules.QueueConstrainerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `QueueConstrainers` . The search query is constructed using the `QueueConstrainerQuery` . `getQueueConstrainersByQuery()` is the basic search method and returns a list of `QueueConstrainers` . A more advanced search may be performed with `getQueueConstrainersBySearch()` . It accepts a `QueueConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQueueConstrainersBySearch()` returns a `QueueConstrainerSearchResults` that can be used to access the resulting `QueueConstrainerList` or be used to perform a search within the result set through Qu `eueConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include queue constrainers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to queue constrainers in this distributor Queue constrainers may have a query record indicated by their respective record types. The query record is accessed via the `QueueConstrainerQuery` .
Method	getQueueConstrainerSearch
Description	Gets a queue constrainer search.
Return	`osid.provisioning.rules.QueueConstrainerSearch`		the queue constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerSearchOrder
Description	Gets a queue constrainer search order. The `QueueConstrainerSearchOrder` is supplied to a `QueueConstrainerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.QueueConstrainerSearchOrder`		the queue constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.QueueConstrainerQuery`	`queueConstrainerQuery`	the queue constrainer query
Parameters	`osid.provisioning.rules.QueueConstrainerSearch`	`queueConstrainerSearch`	the queue constrainer search
Return	`osid.provisioning.rules.QueueConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`queueConstrainerQuery` or `queueConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueConstrainerQuery` or `queueConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerQueryFromInspector
Description	Gets a queue constrainer query from an inspector. The inspector is available from a `QueueConstrainerSearchResults` .
Parameters	`osid.provisioning.rules.QueueConstrainerQueryInspector`	`queueConstrainerQueryInspector`	a queue constrainer query inspector
Return	`osid.provisioning.rules.QueueConstrainerQuery`		the queue constrainer query
Errors	NULL_ARGUMENT		`queueConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.