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