public interface DictionaryNodeList extends OsidList
Like all OsidLists,
DictionaryNodeList
provides a means for accessing DictionaryNode
elements
sequentially either one at a time or many at a time. Examples:
while (dnl.hasNext()) { DictionaryNode node = dnl.getNextDictionaryNode(); }or
while (dnl.hasNext()) { DictionaryNode[] nodes = dnl.getNextDictionaryNodes(dnl.available()); }
Modifier and Type | Method and Description |
---|---|
DictionaryNode |
getNextDictionaryNode()
Gets the next
DictionaryNode in this list. |
DictionaryNode[] |
getNextDictionaryNodes(long n)
Gets the next set of
DictionaryNode objects in this lis
which must be less than or equal to whst is returned from
available(). |
DictionaryNode getNextDictionaryNode() throws OperationFailedException
DictionaryNode
in this list. DictionaryNode
in this list. The
hasNext()
method should be used to test that a
next DictionaryNode
is available before calling
this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DictionaryNode[] getNextDictionaryNodes(long n) throws OperationFailedException
DictionaryNode
objects in this lis
which must be less than or equal to whst is returned from
available().
n
- the number of DictionaryNode
elements
requested which should be less than or equal to
available()
DictionaryNode
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.