OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.QueueProcessor
Implementsosid.OsidProcessor
Used Byosid.provisioning.rules.QueueProcessorAdminSession
osid.provisioning.rules.QueueProcessorList
osid.provisioning.rules.QueueProcessorLookupSession
Description

A QueueProcessor manages the operation of a Queue .

MethodisAutomatic
Description

Tests if the processing of the queue is automatic.

Returnbooleantrue if the queue processing is automatic, false if processed manually
CompliancemandatoryThis method must be implemented.
MethodisFifo
Description

Tests if this queue is first in first out.

Returnbooleantrue if the queue is a fifo, false otherwise
CompliancemandatoryThis method must be implemented.
MethodremovesProcessedQueueEntries
Description

Tests if processed queue entries are removed.

Returnbooleantrue if the processed entries are removed, false if processed queue entries remain but marked ineffective
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorRecord
Description

Gets the queue processor record corresponding to the given QueueProcessor record Type . This method ie used to retrieve an object implementing the requested record. The queueProcessorRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(queueProcessorRecordType) is true.

Parametersosid.type.TypequeueProcessorRecordTypethe type of queue processor record to retrieve
Returnosid.provisioning.rules.records.QueueProcessorRecordthe queue processor record
ErrorsNULL_ARGUMENTqueueProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(queueProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.