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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RealmBatchForm form = rbfl.getNextRealmBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RealmBatchForm[] forms = rbfl.getNextRealmBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRealmBatchForm
Description

Gets the next RealmBatchForm in this list.

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

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

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