OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueConstrainerSearch
Implementsosid.OsidSearch
Description

The search interface for governing queue constrainer searches.

MethodsearchAmongQueueConstrainers
Description

Execute this search among the given list of queue constrainers.

Parametersosid.id.IdListfrontOfficeIdslist of queue constrainers
ErrorsNULL_ARGUMENT frontOfficeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.tracking.rules.QueueConstrainerSearchOrderqueueConstrainerSearchOrderqueue constrainer search order
ErrorsNULL_ARGUMENT queueConstrainerSearchOrder is null
UNSUPPORTED queueConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerSearchRecord
Description

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

Parametersosid.type.TypequeueConstrainerSearchRecordTypea queue constrainer search record type
Returnosid.tracking.rules.records.QueueConstrainerSearchRecordthe queue constrainer search record
ErrorsNULL_ARGUMENT queueConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.