OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.subscription.rules.DispatchConstrainerSearchSession
Description

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

MethodgetDispatchConstrainers
Description

Gets the dispatch constrainer list resulting from a search.

Returnosid.subscription.rules.DispatchConstrainerListthe dispatch constrainer list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDispatchConstrainerQueryInspector
Description

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

Returnosid.subscription.rules.DispatchConstrainerQueryInspectorthe dispatch constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDispatchConstrainerSearchResultsRecord
Description

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

Parametersosid.type.TypedispatchConstrainerSearchRecordTypea dispatch constrainer search record type
Returnosid.subscription.rules.records.DispatchConstrainerSearchResultsRecordthe dispatch constrainer search results record
ErrorsNULL_ARGUMENTdispatchConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.