Interface DispatchConstrainerEnablerList

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

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

while (cel.hasNext()) {
     DispatchConstrainerEnabler enabler = cel.getNextDispatchConstrainerEnabler();
}

or

while (cel.hasNext()) {
     DispatchConstrainerEnabler[] enablers = cel.getNextDispatchConstrainerEnablers(cel.available());
}

  • Method Details

    • getNextDispatchConstrainerEnabler

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

    • getNextDispatchConstrainerEnablers

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