OSID Logo
OSID Specifications
hierarchy package
Version 3.1.0
Interfaceosid.hierarchy.HierarchyList
Implementsosid.OsidList
Used Byosid.hierarchy.HierarchyLookupSession
osid.hierarchy.HierarchyQuerySession
osid.hierarchy.HierarchySearchResults
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.Hierarchy the next Hierarchy in this list. The hasNext() method should be used to test that a next Hierarchy is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.