OSID - osid.subscription.rules.DispatchProcessorEnablerSearchSession Service Interface Definition

Interface	osid.subscription.rules.DispatchProcessorEnablerSearchSession
Implements	`osid.subscription.rules.DispatchProcessorEnablerQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchProcessorEnablers`. The search query is constructed using the `DispatchProcessorEnablerQuery`. `getDispatchProcessorEnablersByQuery()` is the basic search method and returns a list of `DispatchProcessorEnablers`. A more advanced search may be performed with `getDispatchProcessorEnablersBySearch()`.It accepts a `DispatchProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchProcessorEnablersBySearch()` returns a `DispatchProcessorEnablerSearchResults` that can be used to access the resulting `DispatchProcessorEnablerList` or be used to perform a search within the result set through `DispatchProcessorEnablerSearch`. This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch processor enablers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch processor enablers in this publisher Dispatch processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `DispatchProcessorEnablerQuery` .
Method	getDispatchProcessorEnablerSearch
Description	Gets a dispatch processor enabler search.
Return	`osid.subscription.rules.DispatchProcessorEnablerSearch`		the dispatch processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerSearchOrder
Description	Gets a dispatch processor enabler search order. The `DispatchProcessorEnablerSearchOrder` is supplied to a `DispatchProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.subscription.rules.DispatchProcessorEnablerSearchOrder`		the dispatch processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerQuery`	`dispatchProcessorEnablerQuery`	the dispatch processor enabler query
Parameters	`osid.subscription.rules.DispatchProcessorEnablerSearch`	`dispatchProcessorEnablerSearch`	the dispatch processor enabler search
Return	`osid.subscription.rules.DispatchProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerQuery` or `dispatchProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchProcessorEnablerQuery` or `dispatchProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerQueryFromInspector
Description	Gets a dispatch processor enabler query from an inspector. The inspector is available from a `DispatchProcessorEnablerSearchResults`.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerQueryInspector`	`dispatchProcessorEnablerQueryInspector`	a dispatch processor enabler query inspector
Return	`osid.subscription.rules.DispatchProcessorEnablerQuery`		the dispatch processor enabler query
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.