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

Interface	osid.subscription.rules.DispatchConstrainerEnablerSearchSession
Implements	`osid.subscription.rules.DispatchConstrainerEnablerQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchConstrainerEnablers` . The search query is constructed using the `DispatchConstrainerEnablerQuery` . `getDispatchConstrainerEnablersByQuery()` is the basic search method and returns a list of `DispatchConstrainerEnablers` . A more advanced search may be performed with `getDispatchConstrainerEnablersBySearch()` .It accepts a `DispatchConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchConstrainerEnablersBySearch()` returns a `DispatchConstrainerEnablerSearchResults` that can be used to access the resulting `DispatchConstrainerEnablerList` or be used to perform a search within the result set through `DispatchConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch constrainer enablers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch constrainer enablers in this publisher Dispatch constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `DispatchConstrainerEnablerQuery` .
Method	getDispatchConstrainerEnablerSearch
Description	Gets a dispatch constrainer enabler search.
Return	`osid.subscription.rules.DispatchConstrainerEnablerSearch`		the dispatch constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerSearchOrder
Description	Gets a dispatch constrainer enabler search order. The `DispatchConstrainerEnablerSearchOrder` is supplied to a `DispatchConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.subscription.rules.DispatchConstrainerEnablerSearchOrder`		the dispatch constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.DispatchEnablerQuery`	`dispatchConstrainerEnablerQuery`	the dispatch constrainer enabler query
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerSearch`	`dispatchConstrainerEnablerSearch`	the dispatch constrainer enabler search
Return	`osid.subscription.rules.DispatchConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerQuery` or `dispatchConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchConstrainerEnablerQuery` or `dispatchConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerQueryFromInspector
Description	Gets a dispatch constrainer enabler query from an inspector. The inspector is available from a `DispatchConstrainerEnablerSearchResults` .
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerQueryInspector`	`dispatchConstrainerEnablerQueryInspector`	a dispatch constrainer enabler query inspector
Return	`osid.subscription.rules.DispatchConstrainerEnablerQuery`		the dispatch constrainer enabler query
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.