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