public interface QueueProcessor extends OsidProcessor
A QueueProcessor
describes the rules for managing the
behavior of a queue.
Modifier and Type | Method and Description |
---|---|
QueueProcessorRecord |
getQueueProcessorRecord(Type queueProcessorRecordType)
Gets the queue processor record corresponding to the given
QueueProcessor record Type. |
boolean |
isAutomatic()
Tests if the processing of the queue is automatic.
|
boolean |
isFifo()
Tests if this queue is first in first out.
|
boolean |
removesProcessedQueueEntries()
Tests if processed queue entries are removed.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
boolean isAutomatic()
true
if the queue processing is automatic,
false
if processed manuallymandatory
- This method must be implemented. boolean isFifo()
true
if the queue is a fifo, false
otherwisemandatory
- This method must be implemented. boolean removesProcessedQueueEntries()
true
if the processed entries are removed,
false
if processed queue entries remain but
marked ineffectivemandatory
- This method must be implemented. QueueProcessorRecord getQueueProcessorRecord(Type queueProcessorRecordType) throws OperationFailedException
QueueProcessor
record Type.
This method is 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
.queueProcessorRecordType
- the type of queue processor record to
retrieveNullArgumentException
- queueProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueProcessorRecordType)
is
false
mandatory
- This method must be implemented.