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

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

                     
                     
                     while (obfl.hasNext()) {
                          OrganizationBatchForm form = obfl.getNextOrganizationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (obfl.hasNext()) {
                          OrganizationBatchForm[] forms = obfl.getNextOrganizationBatchForms(obfl.available());
                     }
                     
                                 
                     
                
MethodgetNextOrganizationBatchForm
Description

Gets the next OrganizationBatchForm in this list.

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

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

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