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