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