org.osid.authorization

Interface VaultNodeList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface VaultNodeList
extends OsidList

Like all OsidLists, VaultNodeList provides a means for accessing VaultNode elements sequentially either one at a time or many at a time. Examples:

       
       
       while (vnl.hasNext()) {
            VaultNode node = vnl.getNextVaultNode();
       }
       
                   
       
  

or

       
       
       while (vnl.hasNext()) {
            VaultNode[] nodes = vnl.getNextVaultNodes(vnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
VaultNode	getNextVaultNode() Gets the next VaultNode in this list.
VaultNode[]	getNextVaultNodes(long n) Gets the next set of VaultNode elements in this list which must be less than or equal to the return from available().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextVaultNode

VaultNode getNextVaultNode()
                           throws OperationFailedException

Gets the next VaultNode in this list.

Returns:

the next VaultNode in this list. The hasNext() method should be used to test that a next VaultNode 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.

getNextVaultNodes

VaultNode[] getNextVaultNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

an array of VaultNode 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.