OSID Logo
OSID Specifications
profile batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.batch.ProfileEntryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pebfl.hasNext()) {
                          ProfileEntryBatchForm form = pebfl.getNextProfileEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pebfl.hasNext()) {
                          ProfileEntryBatchForm[] forms = pebfl.getNextProfileEntryBatchForms(pebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileEntryBatchForm
Description

Gets the next ProfileEntryBatchForm in this list.

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

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

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