public interface HierarchyList extends OsidList
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()); }
Modifier and Type | Method and Description |
---|---|
Hierarchy[] |
getNextHierarchies(long n)
Gets the next set of
Hierarchy objects in this list. |
Hierarchy |
getNextHierarchy()
Gets the next
Hierarchy in this list. |
Hierarchy getNextHierarchy() throws OperationFailedException
Hierarchy
in this list. Hierarchy
in this list. The
hasNext()
method should be used to test that a next
Hierarchy
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Hierarchy[] getNextHierarchies(long n) throws OperationFailedException
Hierarchy
objects in this list.
The specified amount must be less than or equal to the return from
available().
n
- the number of Hierarchy
elements requested
which must be less than or equal to available()
Hierarchy
elements.
The length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.