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