Interface DispatchProcessorEnablerList

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

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

while (pel.hasNext()) {
     DispatchProcessorEnabler enabler = pel.getNextDispatchProcessorEnabler();
}

or

while (pel.hasNext()) {
     DispatchProcessorEnabler[] enablers = pel.getNextDispatchProcessorEnablers(pel.available());
}

  • Method Details

    • getNextDispatchProcessorEnabler

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

    • getNextDispatchProcessorEnablers

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