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