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