OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

This is the query for searching queue constrainers. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledQueueId
Description

Matches mapped to a queue.

Parametersosid.id.IdqueueIdthe queue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT queueId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueIdTerms
Description

Clears the queue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledQueueQuery
Description

Tests if a QueueQuery is available.

Returnboolean true if a queue query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledQueueQuery
Description

Gets the query for a queue. Multiple retrievals produce a nested OR term.

Returnosid.tracking.QueueQuerythe queue query
ErrorsUNIMPLEMENTED supportsRuledQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledQueueQuery() is true.
MethodmatchAnyRuledQueue
Description

Matches constrainers mapped to any queue.

Parametersbooleanmatch true for constrainers mapped to any queue, false to match constrainers mapped to no queues
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueTerms
Description

Clears the queue query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFrontOfficeId
Description

Matches constrainers mapped to the front office.

Parametersosid.id.IdfrontOfficeIdthe front office Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT frontOfficeId is null
CompliancemandatoryThis method must be implemented.
MethodclearFrontOfficeIdTerms
Description

Clears the front office Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFrontOfficeQuery
Description

Tests if an FrontOfficeQuery is available.

Returnboolean true if a front office query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeQuery
Description

Gets the query for a front office. Multiple retrievals produce a nested OR term.

Returnosid.tracking.FrontOfficeQuerythe front office query
ErrorsUNIMPLEMENTED supportsFrontOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeQuery() is true.
MethodclearFrontOfficeTerms
Description

Clears the front office query terms.

CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerQueryRecord
Description

Gets the queue constrainer query record corresponding to the given QueueConstrainer record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypequeueConstrainerRecordTypea queue constrainer record type
Returnosid.tracking.rules.records.QueueConstrainerQueryRecordthe queue constrainer query record
ErrorsNULL_ARGUMENT queueConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.