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