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