org.osid.financials

Interface AccountList

All Superinterfaces:

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

public interface AccountList
extends OsidList

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

       
       
       while (aul.hasNext()) {
            Account unit = aul.getNextAccount();
       }
       
                   
       
  

or

       
       
       while (aul.hasNext()) {
            Account[] units = aul.getNextAccounts(aul.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAccount

Account getNextAccount()
                       throws OperationFailedException

Gets the next Account in this list.

Returns:

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

getNextAccounts

Account[] getNextAccounts(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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