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