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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PositionBatchForm form = pbfl.getNextPositionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PositionBatchForm[] forms = pbfl.getNextPositionBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPositionBatchForm
Description

Gets the next PositionBatchForm in this list.

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

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

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