Interface StepProcessorEnablerList

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

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

while (spel.hasNext()) {
     StepProcessorEnabler enabler = spel.getNextStepProcessorEnabler();
}
or 
while (spel.hasNext()) {
     StepProcessorEnabler[] enablers = qpel.getNextStepProcessorEnablers(spel.available());
}

  • Method Details

    • getNextStepProcessorEnabler

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

    • getNextStepProcessorEnablers

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