OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchSearchSession
Implementsosid.subscription.DispatchQuerySession
Description

This session provides methods for searching Dispatch objects. 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.

MethodgetDispatchSearch
Description

Gets a dispatch search.

Returnosid.subscription.DispatchSearchthe dispatch search
CompliancemandatoryThis method must be implemented.
MethodgetDispatchSearchOrder
Description

Gets a dispatch search order. The DispatchSearchOrder is supplied to a DispatchSearch to specify the ordering of results.

Returnosid.subscription.DispatchSearchOrderthe dispatch search order
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesBySearch
Description

Gets the search results matching the given search.

Parametersosid.subscription.DispatchQuerydispatchQuerythe dispatch query
osid.subscription.DispatchSearchdispatchSearchthe dispatch search
Returnosid.subscription.DispatchSearchResultsthe dispatch search results
ErrorsNULL_ARGUMENT dispatchQuery or dispatchSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED dispatchQuery or dispatchSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDispatchQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an DispatchSearchResults.

Parametersosid.subscription.DispatchQueryInspectordispatchQueryInspectora query inspector
Returnosid.subscription.DispatchQuerythe entry query
ErrorsNULL_ARGUMENT dispatchQueryInspector is null
UNSUPPORTED dispatchQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.