Interface QueueConstrainerEnablerList

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

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

while (qcel.hasNext()) {
     QueueConstrainerEnabler enabler = qcel.getNextQueueConstrainerEnabler();
}

or

while (qcel.hasNext()) {
     QueueConstrainerEnabler[] enablers = qcel.getNextQueueConstrainerEnablers(qcel.available());
}

  • Method Details

    • getNextQueueConstrainerEnabler

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

    • getNextQueueConstrainerEnablers

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