Interface QueueProcessorEnablerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface QueueProcessorEnablerList extends OsidList

Like all OsidLists , QueueProcessorEnablerList provides a means for accessing QueueProcessorEnabler elements sequentially either one at a time or many at a time. Examples: 

while (qpel.hasNext()) {
     QueueProcessorEnabler enabler = qpel.getNextQueueProcessorEnabler();
}
or 
while (qpel.hasNext()) {
     QueueProcessorEnabler[] enablers = qpel.getNextQueueProcessorEnablers(qpel.available());
}

  • Method Details

    • getNextQueueProcessorEnabler

      QueueProcessorEnabler getNextQueueProcessorEnabler() throws OperationFailedException
      Gets the next QueueProcessorEnabler in this list.
      Returns:
      the next QueueProcessorEnabler in this list. The hasNext() method should be used to test that a next QueueProcessorEnabler is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextQueueProcessorEnablers

      QueueProcessorEnabler[] getNextQueueProcessorEnablers(long n) throws OperationFailedException
      Gets the next set of QueueProcessorEnabler elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of QueueProcessorEnabler elements requested which must be less than or equal to available()
      Returns:
      an array of QueueProcessorEnabler elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.