Interface QueueConstrainerList

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

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

while (qcl.hasNext()) {
     QueueConstrainer constrainer = qcl.getNextQueueConstrainer();
}

or

while (qcl.hasNext()) {
     QueueConstrainer[] constrainers = qcl.getNextQueueConstrainers(qcl.available());
}

  • Method Details

    • getNextQueueConstrainer

      QueueConstrainer getNextQueueConstrainer() throws OperationFailedException
      Gets the next QueueConstrainer in this list.
      Returns:
      the next QueueConstrainer in this list. The hasNext() method should be used to test that a next QueueConstrainer 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.

    • getNextQueueConstrainers

      QueueConstrainer[] getNextQueueConstrainers(long n) throws OperationFailedException
      Gets the next set of QueueConstrainer elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of QueueConstrainer elements requested which must be less than or equal to available()
      Returns:
      an array of QueueConstrainer 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.