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

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

MethodmatchRuledQueueProcessorId
Description

Matches enablers mapped to the queue processor.

Parametersosid.id.IdqueueProcessorIdthe queue processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT queueProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueProcessorIdTerms
Description

Clears the queue processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledQueueProcessorQuery
Description

Tests if a QueueProcessorQuery is available.

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

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

Returnosid.tracking.rules.QueueProcessorQuerythe queue processor query
ErrorsUNIMPLEMENTED supportsRuledQueueProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledQueueProcessorQuery() is true.
MethodmatchAnyRuledQueueProcessor
Description

Matches enablers mapped to any queue processor.

Parametersbooleanmatch true for enablers mapped to any queue processor, false to match enablers mapped to no queue processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueProcessorTerms
Description

Clears the queue processor 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.
MethodgetQueueProcessorEnablerQueryRecord
Description

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

Parametersosid.type.TypequeueProcessorEnablerRecordTypea queue processor enabler record type
Returnosid.tracking.rules.records.QueueProcessorEnablerQueryRecordthe queue processor enabler query record
ErrorsNULL_ARGUMENT queueProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.