OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyList
Implementsosid.OsidList
Description

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

                     
                     
                     while (hl.hasNext()) {
                          Hierarchy hierarchy = hl.getNextHierarchy();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (hl.hasNext()) {
                          Hierarchy[] hierarchies = hl.getNextHierarchies(hl.available());
                     }
                     
                                 
                     
                
MethodgetNextHierarchy
Description

Gets the next Hierarchy in this list.

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

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

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