OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.subscription.rules.DispatchEnablerSearchSession
Description

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

MethodgetDispatchEnablers
Description

Gets the dispatch enabler list resulting from a search.

Returnosid.subscription.rules.DispatchEnablerList the dispatch enabler list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDispatchEnablerQueryInspector
Description

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

Returnosid.subscription.rules.DispatchEnablerQueryInspector the dispatch enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetDispatchEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypedispatchEnablerSearchRecordType a dispatch enabler search record type
Returnosid.subscription.rules.records.DispatchEnablerSearchResultsRecord the dispatch enabler search results record
ErrorsNULL_ARGUMENT dispatchEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.