OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueConstrainerEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledQueueConstrainerId
Description

Matches enablers mapped to the queue constrainer.

Parametersosid.id.IdqueueConstrainerIdthe queue constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT queueConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueConstrainerIdTerms
Description

Clears the queue constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledQueueConstrainerQuery
Description

Tests if a QueueConstrainerQuery is available.

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

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

Returnosid.tracking.rules.QueueConstrainerQuerythe queue constrainer query
ErrorsUNIMPLEMENTED supportsRuledQueueConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledQueueConstrainerQuery() is true.
MethodmatchAnyRuledQueueConstrainer
Description

Matches enablers mapped to any queue constrainer.

Parametersbooleanmatch true for enablers mapped to any queue constrainer, false to match enablers mapped to no queue constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueConstrainerTerms
Description

Clears the queue constrainer query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFrontOfficeId
Description

Matches enablers 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.
MethodgetQueueConstrainerEnablerQueryRecord
Description

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

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