public interface CurrencyList extends OsidList
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()); }
Modifier and Type | Method and Description |
---|---|
Currency[] |
getNextCurrencies(long n)
Gets the next set of
Currency elements in this list. |
Currency |
getNextCurrency()
Gets the next
Currency in this list. |
Currency getNextCurrency() throws OperationFailedException
Currency
in this list. Currency
in this list. The
hasNext()
method should be used to test that a next
Currency
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Currency[] getNextCurrencies(long n) throws OperationFailedException
Currency
elements in this list.
The specified amount must be less than or equal to the return from
available().
n
- the number of Currency
elements requested
which must be less than or equal to available()
Currency
elements.
The length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.