OSID Logo
OSID Specifications
journaling batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.batch.BranchBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bbfl.hasNext()) {
                          BranchBatchForm form = bbfl.getNextBranchBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BranchBatchForm[] forms = bbfl.getNextBranchBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBranchBatchForm
Description

Gets the next BranchBatchForm in this list.

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

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

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