OSID Logo
OSID Specifications
subscription rules package
Version 3.1.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.DispatchConstrainerList the dispatch constrainer list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDispatchConstrainerQueryInspector
Description

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

Returnosid.subscription.rules.DispatchConstrainerQueryInspector the dispatch constrainer query inspector
Compliancemandatory This 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.TypedispatchConstrainerSearchRecordType a dispatch constrainer search record type
Returnosid.subscription.rules.records.DispatchConstrainerSearchResultsRecord the dispatch constrainer search results record
ErrorsNULL_ARGUMENT dispatchConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.