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