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