OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.ActionBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          ActionBatchForm form = abfl.getNextActionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          ActionBatchForm[] forms = abfl.getNextActionBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextActionBatchForm
Description

Gets the next ActionBatchForm in this list.

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

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

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