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

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

Returnosid.subscription.rules.DispatchEnablerQueryInspectorthe dispatch enabler query inspector
CompliancemandatoryThis 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.TypedispatchEnablerSearchRecordTypea dispatch enabler search record type
Returnosid.subscription.rules.records.DispatchEnablerSearchResultsRecordthe dispatch enabler search results record
ErrorsNULL_ARGUMENTdispatchEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.