Interface PoolProcessorEnablerList

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

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

while (ppel.hasNext()) {
     PoolProcessorEnabler enabler = ppel.getNextPoolProcessorEnabler();
}
or 
while (ppel.hasNext()) {
     PoolProcessorEnabler[] enablers = ppel.getNextPoolProcessorEnablers(ppel.available());
}

  • Method Details

    • getNextPoolProcessorEnabler

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

    • getNextPoolProcessorEnablers

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