com.prowidesoftware.swift.model.field

Interface CurrencyContainer

All Superinterfaces:

PatternContainer

All Known Implementing Classes:

Field11A, Field19A, Field19B, Field26N, Field26P, Field32A, Field32B, Field32C, Field32D, Field32E, Field32G, Field32H, Field32K, Field32M, Field32N, Field32P, Field32Q, Field32R, Field32U, Field33A, Field33B, Field33C, Field33D, Field33E, Field33F, Field33G, Field33K, Field33N, Field33P, Field33R, Field34A, Field34B, Field34E, Field34F, Field34G, Field34N, Field34P, Field34R, Field39D, Field39P, Field68A, Field68B, Field68C, Field71F, Field71G, Field71H, Field71J, Field71K, Field71L, Field90B, Field90C, Field90D, Field90F, Field90J, Field92B, Field92F, Field92J, Field92L, Field92M, Field92N

public interface CurrencyContainer
extends PatternContainer

Interface to mark fields whose definition contain a currency. Note that if a field has a currency and it is optional, and the actual field has not set the optional currency/ies then the call currencies() will return an empty list

Since:

6.0

Version:

$Revision: 1.1 $

Author:

www.prowidesoftware.com

Method Summary

Methods

Modifier and Type	Method and Description
List<Currency>	currencies() Utility method that creates a Currency for every string returned by currencyStrings()
Currency	currency() Analog to currencyString()
String	currencyString() Get the single currency contained in this field.
List<String>	currencyStrings() Get a list of strings of currencies present in this field
void	initializeCurrencies(Currency cur)
void	initializeCurrencies(String cur) set the currency of this field.

Methods inherited from interface com.prowidesoftware.swift.model.field.PatternContainer

componentsPattern, parserPattern

Method Detail

currencies

List<Currency> currencies()

Utility method that creates a Currency for every string returned by currencyStrings()

currency

Currency currency()

Analog to currencyString()

See Also:

currencyStrings(), currencyString()

currencyString

String currencyString()

Get the single currency contained in this field.

Returns:

null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.

currencyStrings

List<String> currencyStrings()

Get a list of strings of currencies present in this field

Returns:

a list, with zero or more currencies in this field.

initializeCurrencies

void initializeCurrencies(Currency cur)

See Also:

initializeCurrencies(String)

initializeCurrencies

void initializeCurrencies(String cur)

set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.