OSID Logo
OSID Specifications
personnel batch package
Version 3.1.0
Interfaceosid.personnel.batch.PersonBatchFormList
Implementsosid.OsidList
Used Byosid.personnel.batch.PersonBatchAdminSession
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.PersonBatchForm the next PersonBatchForm in this list. The hasNext() method should be used to test that a next PersonBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.