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