Interface QueueProcessor

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule
public interface QueueProcessor extends OsidProcessor

A QueueProcessor manages the operation of a Queue.

  • Method Details

    • isAutomatic

      boolean isAutomatic()
      Tests if the processing of the queue is automatic.
      Returns:
      true if the queue processing is automatic, false if processed manually
      Compliance:
      mandatory - This method must be implemented.

    • isFifo

      boolean isFifo()
      Tests if this queue is first in first out.
      Returns:
      true if the queue is a fifo, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • removesProcessedQueueEntries

      boolean removesProcessedQueueEntries()
      Tests if processed queue entries are removed.
      Returns:
      true if the processed entries are removed, false if processed queue entries remain but marked ineffective
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorRecord

      QueueProcessorRecord getQueueProcessorRecord(Type queueProcessorRecordType) throws OperationFailedException
      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.
      Parameters:
      queueProcessorRecordType - the type of queue processor record to retrieve
      Returns:
      the queue processor record
      Throws:
      NullArgumentException - queueProcessorRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(queueProcessorRecordType) is false
      Compliance:
      mandatory - This method must be implemented.