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

Interface	osid.provisioning.rules.QueueProcessorSearchSession
Implements	`osid.provisioning.rules.QueueProcessorQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `QueueProcessors` . The search query is constructed using the `QueueProcessorQuery` . `getQueueProcessorsByQuery()` is the basic search method and returns a list of `QueueProcessors` . A more advanced search may be performed with `getQueueProcessorsBySearch()` . It accepts a `QueueProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQueueProcessorsBySearch()` returns a `QueueProcessorSearchResults` that can be used to access the resulting `QueueProcessorList` or be used to perform a search within the result set through Qu `eueProcessorSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include queue processors in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to queue processors in this distributor Queue processors may have a query record indicated by their respective record types. The query record is accessed via the `QueueProcessorQuery` .
Method	getQueueProcessorSearch
Description	Gets a queue processor search.
Return	`osid.provisioning.rules.QueueProcessorSearch`		the queue processor search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorSearchOrder
Description	Gets a queue processor search order. The `QueueProcessorSearchOrder` is supplied to a `QueueProcessorSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.QueueProcessorSearchOrder`		the queue processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.QueueProcessorQuery`	`queueProcessorQuery`	the queue processor query
Parameters	`osid.provisioning.rules.QueueProcessorSearch`	`queueProcessorSearch`	the queue processor search
Return	`osid.provisioning.rules.QueueProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`queueProcessorQuery` or `queueProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueProcessorQuery` or `queueProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorQueryFromInspector
Description	Gets a queue processor query from an inspector. The inspector is available from a `QueueProcessorSearchResults` .
Parameters	`osid.provisioning.rules.QueueProcessorQueryInspector`	`queueProcessorQueryInspector`	a queue processor query inspector
Return	`osid.provisioning.rules.QueueProcessorQuery`		the queue processor query
Errors	NULL_ARGUMENT		`queueProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`queueProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.