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

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

                     
                     
                     while (bl.hasNext()) {
                          Branch branch = bl.getNextBranch();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Branch[] branches = bl.getNextBranches(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBranch
Description

Gets the next Branch in this list.

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

Gets the next set of Branches in this list which must be less than or equal to the return from available().

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