Interface DispatchEnablerList

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

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

while (el.hasNext()) {
     DispatchEnabler enabler = el.getNextDispatchEnabler();
}

or

while (el.hasNext()) {
     DispatchEnabler[] enablers = el.getNextDispatchEnablers(el.available());
}

  • Method Details

    • getNextDispatchEnabler

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

    • getNextDispatchEnablers

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