OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.PersonBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          PersonBatchForm form = pbfl.getNextPersonBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PersonBatchForm[] forms = pbfl.getNextPersonBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPersonBatchForm
Description

Gets the next PersonBatchForm in this list.

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

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

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