OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchProcessorEnablerSearch
Implementsosid.OsidSearch
Used Byosid.subscription.rules.DispatchProcessorEnablerSearchSession
Description

The search interface for governing dispatch processor enabler searches.

MethodsearchAmongDispatchProcessorEnablers
Description

Execute this search among the given list of dispatch processor enablers.

Parametersosid.id.IdListdispatchProcessorEnablerIdslist of dispatch processor enablers
ErrorsNULL_ARGUMENTdispatchProcessorEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDispatchProcessorEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchProcessorEnablerSearchOrderdispatchProcessorEnablerSearchOrderdispatch processor enabler search order
ErrorsNULL_ARGUMENTdispatchProcessorEnablerSearchOrder is null
UNSUPPORTEDdispatchProcessorEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDispatchProcessorEnablerSearchRecord
Description

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

Parametersosid.type.TypedispatchProcessorEnablerSearchRecordTypea dispatch processor enabler search record type
Returnosid.subscription.rules.records.DispatchProcessorEnablerSearchRecordthe dispatch processor enabler search record
ErrorsNULL_ARGUMENTdispatchProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.