OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorQuery
Implementsosid.OsidProcessorQuery
Description

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

MethodmatchAutomatic
Description

Matches automatic processors.

Parametersbooleanmatch true to match automatic processors, false to match manual processors
CompliancemandatoryThis method must be implemented.
MethodclearAutomaticTerms
Description

Clears the automatic query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFifo
Description

Matches first-in-first-out processors.

Parametersbooleanmatch true to match fifo processors, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearFifoTerms
Description

Clears the fifo query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRemovesProcessedQueueEntries
Description

Matches processors that remove processed queue entries.

Parametersbooleanmatch true to match removing queue entry processors, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearRemovesProcessedQueueEntriesTerms
Description

Clears the removes processed queue entries query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRuledQueueId
Description

Matches mapped to the 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.provisioning.QueueQuerythe queue query
ErrorsUNIMPLEMENTED supportsRuledQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledQueueQuery() is true.
MethodmatchAnyRuledQueue
Description

Matches mapped to any queue.

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

Clears the queue query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Matches mapped to the distributor.

Parametersosid.id.IddistributorIdthe distributor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodclearDistributorIdTerms
Description

Clears the distributor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorQuery
Description

Tests if a DistributorQuery is available.

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

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

Returnosid.provisioning.DistributorQuerythe distributor query
ErrorsUNIMPLEMENTED supportsDistributorQuery() is false
ComplianceoptionalThis method must be implemented if supportsDistributorQuery() is true.
MethodclearDistributorTerms
Description

Clears the distributor query terms.

CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorQueryRecord
Description

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

Parametersosid.type.TypequeueProcessorRecordTypea queue processor record type
Returnosid.provisioning.rules.records.QueueProcessorQueryRecordthe queue processor query record
ErrorsNULL_ARGUMENT queueProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.