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

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

                     
                     
                     while (ebfl.hasNext()) {
                          EffortBatchForm form = ebfl.getNextEffortBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          EffortBatchForm[] forms = ebfl.getNextEffortBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextEffortBatchForm
Description

Gets the next EffortBatchForm in this list.

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

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

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