OSID Logo
OSID Specifications
profile batch package
Version 3.1.0
Interfaceosid.profile.batch.ProfileBatchFormList
Implementsosid.OsidList
Used Byosid.profile.batch.ProfileBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     ProfileBatchForm form = pbfl.getNextProfileBatchForm();
}
                
or
while (pbfl.hasNext()) {
     ProfileBatchForm[] forms = pbfl.getNextProfileBatchForms(pbfl.available());
}
                
MethodgetNextProfileBatchForm
Description

Gets the next ProfileBatchForm in this list.

Returnosid.profile.batch.ProfileBatchForm the next ProfileBatchForm in this list. The hasNext() method should be used to test that a next ProfileBatchForm 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.
MethodgetNextProfileBatchForms
Description

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

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