Interface DispatchConstrainerList

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

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

while (cl.hasNext()) {
     DispatchConstrainer constrainer = cl.getNextDispatchConstrainer();
}

or

while (cl.hasNext()) {
     DispatchConstrainer[] constrainers = cl.getNextDispatchConstrainers(cl.available());
}

  • Method Details

    • getNextDispatchConstrainer

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

    • getNextDispatchConstrainers

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