org.osid.resourcing

Interface JobList

All Superinterfaces:

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

public interface JobList
extends OsidList

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

       
       
       while (jl.hasNext()) {
            Job job = jl.getNextJob();
       }
       
                   
       
  

or

       
       
       while (jl.hasNext()) {
            Job[] jobs = jl.getNextJobs(jl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Job	getNextJob() Gets the next Job in this list.
Job[]	getNextJobs(long n) Gets the next set of Job 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

getNextJob

Job getNextJob()
               throws OperationFailedException

Gets the next Job in this list.

Returns:

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

getNextJobs

Job[] getNextJobs(long n)
                  throws OperationFailedException

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

Parameters:

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

Returns:

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