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

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

                     
                     
                     while (jbfl.hasNext()) {
                          JobBatchForm form = jbfl.getNextJobBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (jbfl.hasNext()) {
                          JobBatchForm[] forms = jbfl.getNextJobBatchForms(jbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextJobBatchForm
Description

Gets the next JobBatchForm in this list.

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

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

Parameterscardinalnthe number of JobBatchForm elements requested which must be less than or equal to available()
Returnosid.resourcing.batch.JobBatchForm[]an array of JobBatchForm 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.