org.osid.resourcing.rules

Interface JobProcessorList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface JobProcessorList
extends OsidList

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

       
       
       while (jpl.hasNext()) {
            JobProcessor processor = jpl.getNextJobProcessor();
       }
       
                   
       
  

or

       
       
       while (jpl.hasNext()) {
            JobProcessor[] processors = jpl.getNextJobProcessors(jpl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
JobProcessor	getNextJobProcessor() Gets the next JobProcessor in this list.
JobProcessor[]	getNextJobProcessors(long n) Gets the next set of JobProcessor elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextJobProcessor

JobProcessor getNextJobProcessor()
                                 throws OperationFailedException

Gets the next JobProcessor in this list.

Returns:

the next JobProcessor in this list. The hasNext() method should be used to test that a next JobProcessor 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.

getNextJobProcessors

JobProcessor[] getNextJobProcessors(long n)
                                    throws OperationFailedException

Gets the next set of JobProcessor elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of JobProcessor elements requested which must be less than or equal to available()

Returns:

an array of JobProcessor 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.