OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.DispatchSearch
Implementsosid.OsidSearch
Used Byosid.subscription.DispatchSearchSession
Description

The search interface for governing dispatch searches.

MethodsearchAmongDispatches
Description

Execute this search among the given list of dispatches.

Parametersosid.id.IdListdispatchIds list of dispatches
ErrorsNULL_ARGUMENT dispatchIds is null
Compliancemandatory This method must be implemented.
MethodorderDispatchResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.DispatchSearchOrderdispatchSearchOrder dispatch search order
ErrorsNULL_ARGUMENT dispatchSearchOrder is null
UNSUPPORTED dispatchSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDispatchSearchRecord
Description

Gets the dis[atch search record corresponding to the given dispatch search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypedispatchSearchRecordType a dispatch search record type
Returnosid.subscription.records.DispatchSearchRecord the dispatch search record
ErrorsNULL_ARGUMENT dispatchSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchSearchRecordType) is false
Compliancemandatory This method must be implemented.