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

Interface	osid.subscription.rules.DispatchEnablerSearchSession
Implements	`osid.subscription.rules.DispatchEnablerQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchEnablers` . The search query is constructed using the `DispatchEnablerQuery` . `getDispatchEnablersByQuery()` is the basic search method and returns a list of `DispatchEnablers` . A more advanced search may be performed with `getDispatchEnablersBySearch()` . It accepts a `DispatchEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchEnablersBySearch()` returns a `DispatchEnablerSearchResults` that can be used to access the resulting `DispatchEnablerList` or be used to perform a search within the result set through `DispatchEnablerSearch` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch enablers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch enablers in this publisher Dispatch enablers may have a query record indicated by their respective record types. The query record is accessed via the `DispatchEnablerQuery` .
Method	getDispatchEnablerSearch
Description	Gets a dispatch enabler search.
Return	`osid.subscription.rules.DispatchEnablerSearch`		the dispatch enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablerSearchOrder
Description	Gets a dispatch enabler search order. The `DispatchEnablerSearchOrder` is supplied to a `DispatchEnablerSearch` to specify the ordering of results.
Return	`osid.subscription.rules.DispatchEnablerSearchOrder`		the dispatch enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.DispatchEnablerQuery`	`dispatchEnablerQuery`	the dispatch enabler query
Parameters	`osid.subscription.rules.DispatchEnablerSearch`	`dispatchEnablerSearch`	the dispatch enabler search
Return	`osid.subscription.rules.DispatchEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dispatchEnablerQuery` or `dispatchEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchEnablerQuery` or `dispatchEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablerQueryFromInspector
Description	Gets a dispatch enabler query from an inspector. The inspector is available from a `DispatchEnablerSearchResults` .
Parameters	`osid.subscription.rules.DispatchEnablerQueryInspector`	`dispatchEnablerQueryInspector`	a dispatch enabler query inspector
Return	`osid.subscription.rules.DispatchEnablerQuery`		the dispatch enabler query
Errors	NULL_ARGUMENT		`dispatchEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.