org.osid.financials

Interface BusinessNodeList

All Superinterfaces:

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

public interface BusinessNodeList
extends OsidList

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

       
       
       while (bnl.hasNext()) {
            BusinessNode node = bnl.getNextBusinessNode();
       }
       
                   
       
  

or

       
       
       while (bnl.hasNext()) {
            BusinessNode[] nodes = bnl.getNextBusinessNodes(bnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBusinessNode

BusinessNode getNextBusinessNode()
                                 throws OperationFailedException

Gets the next BusinessNode in this list.

Returns:

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

getNextBusinessNodes

BusinessNode[] getNextBusinessNodes(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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