Interface DispatchProcessorList

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

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

while (pl.hasNext()) {
     DispatchProcessor processor = pl.getNextDispatchProcessor();
}

or

while (pl.hasNext()) {
     DispatchProcessor[] processors = pl.getNextDispatchProcessors(pl.available());
}

  • Method Details

    • getNextDispatchProcessor

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

    • getNextDispatchProcessors

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