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

Interface	osid.subscription.rules.DispatchConstrainerSearchSession
Implements	`osid.subscription.rules.DispatchConstrainerQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchConstrainers` . The search query is constructed using the `DispatchConstrainerQuery` . `getDispatchConstrainersByQuery()` is the basic search method and returns a list of `DispatchConstrainers` . A more advanced search may be performed with `getDispatchConstrainersBySearch()` . It accepts a `DispatchConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchConstrainersBySearch()` returns a `DispatchConstrainerSearchResults` that can be used to access the resulting `DispatchConstrainerList` or be used to perform a search within the result set through `DispatchConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch constrainers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch constrainers in this publisher Dispatch constrainers may have a query record indicated by their respective record types. The query record is accessed via the `DispatchConstrainerQuery` .
Method	getDispatchConstrainerSearch
Description	Gets a dispatch constrainer search.
Return	`osid.subscription.rules.DispatchConstrainerSearch`		the dispatch constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerSearchOrder
Description	Gets a dispatch constrainer search order. The `DispatchConstrainerSearchOrder` is supplied to a `DispatchConstrainerSearch` to specify the ordering of results.
Return	`osid.subscription.rules.DispatchConstrainerSearchOrder`		the dispatch constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.DispatchConstrainerQuery`	`dispatchConstrainerQuery`	the dispatch constrainer query
Parameters	`osid.subscription.rules.DispatchConstrainerSearch`	`dispatchConstrainerSearch`	the dispatch constrainer search
Return	`osid.subscription.rules.DispatchConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dispatchConstrainerQuery` or `dispatchConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchConstrainerQuery` or `dispatchConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerQueryFromInspector
Description	Gets a dispatch constrainer query from an inspector. The inspector is available from a `DispatchConstrainerSearchResults` .
Parameters	`osid.subscription.rules.DispatchConstrainerQueryInspector`	`dispatchConstrainerQueryInspector`	a dispatch constrainer query inspector
Return	`osid.subscription.rules.DispatchConstrainerQuery`		the dispatch constrainer query
Errors	NULL_ARGUMENT		`dispatchConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.