org.osid.financials

Interface AccountNodeList

All Superinterfaces:

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

public interface AccountNodeList
extends OsidList

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

       
       
       while (anl.hasNext()) {
            AccountNode node = anl.getNextAccountNode();
       }
       
                   
       
  

or

       
       
       while (anl.hasNext()) {
            AccountNode[] nodes = anl.getNextAccountNodes(anl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AccountNode	getNextAccountNode() Gets the next AccountNode in this list.
AccountNode[]	getNextAccountNodes(long n) Gets the next set of AccountNode elements in this list.

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

getNextAccountNode

AccountNode getNextAccountNode()
                               throws OperationFailedException

Gets the next AccountNode in this list.

Returns:

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

getNextAccountNodes

AccountNode[] getNextAccountNodes(long n)
                                  throws OperationFailedException

Gets the next set of AccountNode elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

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

Returns:

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