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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CompetencyBatchForm form = cbfl.getNextCompetencyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CompetencyBatchForm[] forms = cbfl.getNextCompetencyBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCompetencyBatchForm
Description

Gets the next CompetencyBatchForm in this list.

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

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

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