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