OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchEnablerSearch
Implementsosid.OsidSearch
Used Byosid.subscription.rules.DispatchEnablerSearchSession
Description

The search interface for governing dispatch enabler searches.

MethodsearchAmongDispatchEnablers
Description

Execute this search among the given list of dispatch enablers.

Parametersosid.id.IdListdispatchEnablerIds list of dispatch enablers
ErrorsNULL_ARGUMENT dispatchEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderDispatchEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchEnablerSearchOrderdispatchEnablerSearchOrder dispatch enabler search order
ErrorsNULL_ARGUMENT dispatchEnablerSearchOrder is null
UNSUPPORTED dispatchEnablerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDispatchEnablerSearchRecord
Description

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

Parametersosid.type.TypedispatchEnablerSearchRecordType a dispatch enabler search record type
Returnosid.subscription.rules.records.DispatchEnablerSearchRecord the dispatch enabler search record
ErrorsNULL_ARGUMENT dispatchEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.