OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.DispatchProcessorListthe dispatch processor list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDispatchProcessorQueryInspector
Description

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

Returnosid.subscription.rules.DispatchProcessorQueryInspectorthe dispatch processor query inspector
CompliancemandatoryThis 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.TypedispatchProcessorSearchRecordTypea dispatch processor search record type
Returnosid.subscription.rules.records.DispatchProcessorSearchResultsRecordthe dispatch processor search results record
ErrorsNULL_ARGUMENTdispatchProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.