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