OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.IdListdispatchEnablerIdslist of dispatch enablers
ErrorsNULL_ARGUMENTdispatchEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDispatchEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchEnablerSearchOrderdispatchEnablerSearchOrderdispatch enabler search order
ErrorsNULL_ARGUMENTdispatchEnablerSearchOrder is null
UNSUPPORTEDdispatchEnablerSearchOrder is not of this service
CompliancemandatoryThis 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.TypedispatchEnablerSearchRecordTypea dispatch enabler search record type
Returnosid.subscription.rules.records.DispatchEnablerSearchRecordthe dispatch enabler search record
ErrorsNULL_ARGUMENTdispatchEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.