OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchConstrainerSearch
Implementsosid.OsidSearch
Used Byosid.subscription.rules.DispatchConstrainerSearchSession
Description

The search interface for governing dispatch constrainer searches.

MethodsearchAmongDispatchConstrainers
Description

Execute this search among the given list of dispatch constrainers.

Parametersosid.id.IdListdispatchConstrainerIds list of dispatch constrainer
ErrorsNULL_ARGUMENT dispatchConstrainerIds is null
Compliancemandatory This method must be implemented.
MethodorderDispatchConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchConstrainerSearchOrderdispatchConstrainerSearchOrder dispatch constrainer search order
ErrorsNULL_ARGUMENT dispatchConstrainerSearchOrder is null
UNSUPPORTED dispatchConstrainerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDispatchConstrainerSearchRecord
Description

Gets the dispatch constrainer search 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.DispatchConstrainerSearchRecord the dispatch constrainer search record
ErrorsNULL_ARGUMENT dispatchConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.