org.osid.financials

Interface ActivityNodeList

All Superinterfaces:

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

public interface ActivityNodeList
extends OsidList

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

       
       
       while (anl.hasNext()) {
            ActivityNode node = anl.getNextActivityNode();
       }
       
                   
       
  

or

       
       
       while (anl.hasNext()) {
            ActivityNode[] nodes = anl.getNextActivityNodes(anl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ActivityNode	getNextActivityNode() Gets the next ActivityNode in this list.
ActivityNode[]	getNextActivityNodes(long n) Gets the next set of ActivityNode 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

getNextActivityNode

ActivityNode getNextActivityNode()
                                 throws OperationFailedException

Gets the next ActivityNode in this list.

Returns:

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

getNextActivityNodes

ActivityNode[] getNextActivityNodes(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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