Interface ParameterProcessorEnablerList

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

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

while (ppel.hasNext()) {
     ParameterProcessorEnabler enabler = ppel.getNextParameterProcessorEnabler();
}
or 
while (ppel.hasNext()) {
     ParameterProcessorEnabler[] enablers = ppel.getNextParameterProcessorEnablers(ppel.available());
}

  • Method Details

    • getNextParameterProcessorEnabler

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

    • getNextParameterProcessorEnablers

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