OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.IdListdispatchConstrainerIdslist of dispatch constrainer
ErrorsNULL_ARGUMENTdispatchConstrainerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDispatchConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.DispatchConstrainerSearchOrderdispatchConstrainerSearchOrderdispatch constrainer search order
ErrorsNULL_ARGUMENTdispatchConstrainerSearchOrder is null
UNSUPPORTEDdispatchConstrainerSearchOrder is not of this service
CompliancemandatoryThis 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.TypedispatchConstrainerSearchRecordTypea dispatch constrainer search record type
Returnosid.subscription.rules.records.DispatchConstrainerSearchRecordthe dispatch constrainer search record
ErrorsNULL_ARGUMENTdispatchConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.