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