OSID Logo
OSID Specifications
subscription rules package
Version 3.1.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.IdListdispatchProcessorIds list of dispatch processors
ErrorsNULL_ARGUMENT dispatchProcessorIds is null
Compliancemandatory This method must be implemented.
MethodorderDispatchProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchProcessorSearchOrderdispatchProcessorSearchOrder dispatch processor search order
ErrorsNULL_ARGUMENT dispatchProcessorSearchOrder is null
UNSUPPORTED dispatchProcessorSearchOrder is not of this service
Compliancemandatory This 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.TypedispatchProcessorSearchRecordType a dispatch processor search record type
Returnosid.subscription.rules.records.DispatchProcessorSearchRecord the dispatch processor search record
ErrorsNULL_ARGUMENT dispatchProcessorSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchProcessorSearchRecordType) is false
Compliancemandatory This method must be implemented.