OSID - osid.tracking.rules.QueueProcessorEnablerSearchSession Service Interface Definition

Interface	osid.tracking.rules.QueueProcessorEnablerSearchSession
Implements	`osid.tracking.rules.QueueProcessorEnablerQuerySession`
Used By	`osid.tracking.rules.TrackingRulesManager`
Used By	`osid.tracking.rules.TrackingRulesProxyManager`
Description	This session provides methods for searching among `QueueProcessorEnabler` objects. The search query is constructed using the `QueueProcessorEnableryQuery` . `getQueueProcessorEnablersByQuery()` is the basic search method and returns a list of `QueueProcessorEnablers` . A more advanced search may be performed with `getQueueProcessorEnablersBySearch()` .It accepts a `QueueProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as tracking. `getQueueProcessorEnablersBySearch()` returns a `QueueProcessorEnablerSearchResults` that can be used to access the resulting `QueueProcessorEnablerList` or be used to perform a search within the result set through `QueueProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated front office view: searches include queue processor enablers in front office of which this front office matchmaker is an ancestor in the front office hierarchy isolated front office view: searches are restricted to queue processor enablers in this office `QueueProcessorEnablers` may have a query record indicated by their respective query record types. The record is accessed via the `QueueProcessorEnablerQuery` .
Method	getQueueProcessorEnablerSearch
Description	Gets a queue processor enabler search.
Return	`osid.tracking.rules.QueueProcessorEnablerSearch`		the queue processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorEnablerSearchOrder
Description	Gets a queue processor enabler search order. The `QueueProcessorEnablerSearchOrder` is supplied to a `QueueProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.tracking.rules.QueueProcessorEnablerSearchOrder`		the queue processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.tracking.rules.QueueProcessorEnablerQuery`	`queueProcessorEnablerQuery`	the queue processor enabler query
Parameters	`osid.tracking.rules.QueueProcessorEnablerSearch`	`queueProcessorEnablerSearch`	the queue processor enabler search
Return	`osid.tracking.rules.QueueProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`queueProcessorEnablerQuery` or `queueProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueProcessorEnablerQuery` or `queueProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorEnablerQueryFromInspector
Description	Gets a queue processor enabler query from an inspector. The inspector is available from a `QueueProcessorEnablerSearchResults` .
Parameters	`osid.tracking.rules.QueueProcessorEnablerQueryInspector`	`queueProcessorEnablerQueryInspector`	a queue processor enabler query inspector
Return	`osid.tracking.rules.QueueProcessorEnablerQuery`		the queue processor enabler query
Errors	NULL_ARGUMENT		`queueProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.