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

Interface	osid.provisioning.rules.QueueEnablerSearchSession
Implements	`osid.provisioning.rules.QueueEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `QueueEnablers` . The search query is constructed using the `QueueEnablerQuery` . `getQueueEnablersByQuery()` is the basic search method and returns a list of `QueueEnablers` . A more advanced search may be performed with `getQueueEnablersBySearch()` .It accepts a `QueueEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQueueEnablersBySearch()` returns a `QueueEnablerSearchResults` that can be used to access the resulting `QueueEnablerList` or be used to perform a search within the result set through Que `ueEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include queue enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to queue enablers in this distributor Queue enablers may have a query record indicated by their respective record types. The query record is accessed via the `QueueEnablerQuery` .
Method	getQueueEnablerSearch
Description	Gets a queue enabler search.
Return	`osid.provisioning.rules.QueueEnablerSearch`		the queue enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueEnablerSearchOrder
Description	Gets a queue enabler search order. The `QueueEnablerSearchOrder` is supplied to a `QueueEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.QueueEnablerSearchOrder`		the queue enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueueEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.QueueEnablerQuery`	`queueEnablerQuery`	the queue enabler query
Parameters	`osid.provisioning.rules.QueueEnablerSearch`	`queueEnablerSearch`	the queue enabler search
Return	`osid.provisioning.rules.QueueEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`queueEnablerQuery` or `queueEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueEnablerQuery` or `queueEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueEnablerQueryFromInspector
Description	Gets a queue enabler query from an inspector. The inspector is available from a `QueueEnablerSearchResults` .
Parameters	`osid.provisioning.rules.QueueEnablerQueryInspector`	`queueEnablerQueryInspector`	a queue enabler query inspector
Return	`osid.provisioning.rules.QueueEnablerQuery`		the queue enabler query
Errors	NULL_ARGUMENT		`queueEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.