OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchProcessorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.subscription.rules.DispatchProcessorSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetDispatchProcessors
Description

Gets the dispatch processor list resulting from a search.

Returnosid.subscription.rules.DispatchProcessorList the dispatch processor list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDispatchProcessorQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.subscription.rules.DispatchProcessorQueryInspector the dispatch processor query inspector
Compliancemandatory This method must be implemented.
MethodgetDispatchProcessorSearchResultsRecord
Description

Gets the dispatch processor search results 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.DispatchProcessorSearchResultsRecord the dispatch processor search results record
ErrorsNULL_ARGUMENT dispatchProcessorSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchProcessorSearchRecordType) is false
Compliancemandatory This method must be implemented.