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