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