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

Interface	osid.provisioning.rules.QueueConstrainerEnablerSearchSession
Implements	`osid.provisioning.rules.QueueConstrainerEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `QueueConstrainerEnablers` . The search query is constructed using the `QueueConstrainerEnablerQuery` . `getQueueConstrainerEnablersByQuery()` is the basic search method and returns a list of `QueueConstrainerEnablers` . A more advanced search may be performed with `getQueueConstrainerEnablersBySearch()` .It accepts a `QueueConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQueueConstrainerEnablersBySearch()` returns a `QueueConstrainerEnablerSearchResults` that can be used to access the resulting `QueueConstrainerEnablerList` or be used to perform a search within the result set through `QueueConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include queue constrainer enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to queue constrainer enablers in this distributor Queue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `QueueConstrainerEnablerQuery` .
Method	getQueueConstrainerEnablerSearch
Description	Gets a queue constrainer enabler search.
Return	`osid.provisioning.rules.QueueConstrainerEnablerSearch`		the queue constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerEnablerSearchOrder
Description	Gets a queue constrainer enabler search order. The `QueueConstrainerEnablerSearchOrder` is supplied to a `QueueConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.QueueConstrainerEnablerSearchOrder`		the queue constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.QueueEnablerQuery`	`queueConstrainerEnablerQuery`	the queue constrainer enabler query
Parameters	`osid.provisioning.rules.QueueConstrainerEnablerSearch`	`queueConstrainerEnablerSearch`	the queue constrainer enabler search
Return	`osid.provisioning.rules.QueueConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`queueConstrainerEnablerQuery` or `queueConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueConstrainerEnablerQuery` or `queueConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerEnablerQueryFromInspector
Description	Gets a queue constrainer enabler query from an inspector. The inspector is available from a `QueueConstrainerEnablerSearchResults` .
Parameters	`osid.provisioning.rules.QueueConstrainerEnablerQueryInspector`	`queueConstrainerEnablerQueryInspector`	a queue constrainer enabler query inspector
Return	`osid.provisioning.rules.QueueConstrainerEnablerQuery`		the queue constrainer enabler query
Errors	NULL_ARGUMENT		`queueConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.