OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.CurrencyList
Implementsosid.OsidList
Description

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

while (cl.hasNext()) {
     Currency currency = cl.getNextCurrency();
}
                
or
while (cl.hasNext()) {
     Currency[] currencies = cl.getNextCurrencies(cl.available());
}
                
MethodgetNextCurrency
Description

Gets the next Currency in this list.

Returnosid.financials.Currency the next Currency in this list. The hasNext() method should be used to test that a next Currency is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextCurrencies
Description

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

Parameterscardinaln the number of Currency elements requested which must be less than or equal to available()
Returnosid.financials.Currency[] an array of Currency elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.