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

Interface	osid.subscription.rules.DispatchProcessorSearchSession
Implements	`osid.subscription.rules.DispatchProcessorQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchProcessors` . The search query is constructed using the `DispatchProcessorQuery` . `getDispatchProcessorsByQuery()` is the basic search method and returns a list of `DispatchProcessors` . A more advanced search may be performed with `getDispatchProcessorsBySearch()` . It accepts a `DispatchProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchProcessorsBySearch()` returns a `DispatchProcessorSearchResults` that can be used to access the resulting `DispatchProcessorList` or be used to perform a search within the result set through `DispatchProcessorSearch` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch processors in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch processors in this publisher Dispatch processors may have a query record indicated by their respective record types. The query record is accessed via the `DispatchProcessorQuery` .
Method	getDispatchProcessorSearch
Description	Gets a dispatch processor search.
Return	`osid.subscription.rules.DispatchProcessorSearch`		the dispatch processor search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorSearchOrder
Description	Gets a dispatch processor search order. The `DispatchProcessorSearchOrder` is supplied to a `DispatchProcessorSearch` to specify the ordering of results.
Return	`osid.subscription.rules.DispatchProcessorSearchOrder`		the dispatch processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.DispatchProcessorQuery`	`dispatchProcessorQuery`	the dispatch processor query
Parameters	`osid.subscription.rules.DispatchProcessorSearch`	`dispatchProcessorSearch`	the dispatch processor search
Return	`osid.subscription.rules.DispatchProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dispatchProcessorQuery` or `dispatchProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchProcessorQuery` or `dispatchProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorQueryFromInspector
Description	Gets a dispatch processor query from an inspector. The inspector is available from a `DispatchProcessorSearchResults` .
Parameters	`osid.subscription.rules.DispatchProcessorQueryInspector`	`dispatchProcessorQueryInspector`	a dispatch processor query inspector
Return	`osid.subscription.rules.DispatchProcessorQuery`		the dispatch processor query
Errors	NULL_ARGUMENT		`dispatchProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.