org.osid.financials

Interface FiscalPeriodList

All Superinterfaces:

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

public interface FiscalPeriodList
extends OsidList

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

       
       
       while (fpl.hasNext()) {
            FiscalPeriod period = fpl.getNextFiscalPeriod();
       }
       
                   
       
  

or

       
       
       while (fpl.hasNext()) {
            FiscalPeriod[] periods = fpl.getNextFiscalPeriods(fpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextFiscalPeriod

FiscalPeriod getNextFiscalPeriod()
                                 throws OperationFailedException

Gets the next FiscalPeriod in this list.

Returns:

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

getNextFiscalPeriods

FiscalPeriod[] getNextFiscalPeriods(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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