Interface JobProcessorEnablerList

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

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

while (jpel.hasNext()) {
     JobProcessorEnabler enabler = jpel.getNextJobProcessorEnabler();
}
or 
while (jpel.hasNext()) {
     JobProcessorEnabler[] enablers = jpel.getNextJobProcessorEnablers(jpel.available());
}

  • Method Details

    • getNextJobProcessorEnabler

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

    • getNextJobProcessorEnablers

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