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