org.osid.financials.budgeting.batch

Interface BudgetPeerList

All Superinterfaces:

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

public interface BudgetPeerList
extends OsidList

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

       
       
       while bpl.hasNext()) {
            BudgetPeer peer = bfl.getNextBudgetPeer();
       }
       
                   
       
  

or

       
       
       while (bpl.hasNext()) {
            BudgetPeer[] peers = bpl.getNextBudgetPeers(bpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBudgetPeer

BudgetPeer getNextBudgetPeer()
                             throws OperationFailedException

Gets the next BudgetPeer in this list.

Returns:

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

getNextBudgetPeers

BudgetPeer[] getNextBudgetPeers(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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