Interface ProcessProcessorEnablerList

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

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

while (ppel.hasNext()) {
     ProcessProcessorEnabler enabler = ppel.getNextProcessProcessorEnabler();
}

or

while (ppel.hasNext()) {
     ProcessProcessorEnabler[] enablers = ppel.getNextProcessProcessorEnablers(ppel.available());
}

  • Method Details

    • getNextProcessProcessorEnabler

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

    • getNextProcessProcessorEnablers

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