OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextJob
Description

Gets the next Job in this list.

Returnosid.resourcing.Jobthe next Job in this list. The hasNext() method should be used to test that a next Job is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextJobs
Description

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

Parameterscardinalnthe number of Job elements requested which must be less than or equal to available()
Returnosid.resourcing.Job[]an array of Job elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.