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