Interface VaultList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

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());
}            
  

Method Summary

Modifier and Type	Method	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() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextVault

Vault getNextVault()
            throws OperationFailedException

Gets the next Vault in this list.

Returns:

the next Vault in this list. The hasNext() method should be used to test that a next Vault is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextVaults

Vault[] getNextVaults(long n)
               throws OperationFailedException

Gets the next set of Vault elements in this list which must be less than or equal to the return from available() .

Parameters:

n - the number of Vault elements requested which must be less than or equal to available()

Returns:

an array of Vault elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.