OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchProcessorSearch
Implementsosid.OsidSearch
Used Byosid.subscription.rules.DispatchProcessorSearchSession
Description

The search interface for governing dispatch processor searches.

MethodsearchAmongDispatchProcessors
Description

Execute this search among the given list of dispatch processors.

Parametersosid.id.IdListdispatchProcessorIdslist of dispatch processors
ErrorsNULL_ARGUMENTdispatchProcessorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDispatchProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchProcessorSearchOrderdispatchProcessorSearchOrderdispatch processor search order
ErrorsNULL_ARGUMENTdispatchProcessorSearchOrder is null
UNSUPPORTEDdispatchProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDispatchProcessorSearchRecord
Description

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

Parametersosid.type.TypedispatchProcessorSearchRecordTypea dispatch processor search record type
Returnosid.subscription.rules.records.DispatchProcessorSearchRecordthe dispatch processor search record
ErrorsNULL_ARGUMENTdispatchProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.