OSID - osid.subscription.DispatchSearchSession Service Interface Definition

Interface	osid.subscription.DispatchSearchSession
Implements	`osid.subscription.DispatchQuerySession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session provides methods for searching `Dispatches` . The search query is constructed using the `DispatchQuery` . The dispatch record `Type` also specifies the record for the dispatch query. `getDispatchesByQuery()` is the basic search method and returns a list of `Dispatch` elements. A more advanced search may be performed with `getDispatchesBySearch()` . It accepts a `DispatchSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDispatchesBySearch()` returns a `DispatchSearchResults` that can be used to access the resulting `DispatchList` or be used to perform a search within the result set through `DispatchSearch` . Dispatches may have a query record indicated by their respective record types. The query record is accessed via the `DispatchQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getDispatchSearch
Description	Gets a dispatch search.
Return	`osid.subscription.DispatchSearch`		the dispatch search
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchSearchOrder
Description	Gets a dispatch search order. The `DispatchSearchOrder` is supplied to a `DispatchSearch` to specify the ordering of results.
Return	`osid.subscription.DispatchSearchOrder`		the dispatch search order
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.subscription.DispatchQuery`	`dispatchQuery`	the dispatch query
Parameters	`osid.subscription.DispatchSearch`	`dispatchSearch`	the dispatch search
Return	`osid.subscription.DispatchSearchResults`		the dispatch search results
Errors	NULL_ARGUMENT		`dispatchQuery` or `dispatchSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchQuery` or `dispatchSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `DispatchSearchResults` .
Parameters	`osid.subscription.DispatchQueryInspector`	`dispatchQueryInspector`	a query inspector
Return	`osid.subscription.DispatchQuery`		the entry query
Errors	NULL_ARGUMENT		`dispatchQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.