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

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

                     
                     
                     while (tbfl.hasNext()) {
                          TriggerBatchForm form = tbfl.getNextTriggerBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tbfl.hasNext()) {
                          TriggerBatchForm[] forms = tbfl.getNextTriggerBatchForms(tbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextTriggerBatchForm
Description

Gets the next TriggerBatchForm in this list.

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

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

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