OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchSearch
Implementsosid.OsidSearch
Description

The search interface for governing dispatch searches.

MethodsearchAmongDispatches
Description

Execute this search among the given list of dispatches.

Parametersosid.id.IdListdispatchIdslist of dispatches
ErrorsNULL_ARGUMENT dispatchIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDispatchResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.DispatchSearchOrderdispatchSearchOrderdispatch search order
ErrorsNULL_ARGUMENT dispatchSearchOrder is null
UNSUPPORTED dispatchSearchOrder is not of this service
CompliancemandatoryThis 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.TypedispatchSearchRecordTypea dispatch search record type
Returnosid.subscription.records.DispatchSearchRecordthe dispatch search record
ErrorsNULL_ARGUMENT dispatchSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dispatchSearchRecordType) is false
CompliancemandatoryThis method must be implemented.