Field92N (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.field.Field
- - com.prowidesoftware.swift.model.field.Field92N

All Implemented Interfaces:

AmountContainer, CurrencyContainer, GenericField, PatternContainer, Serializable
```
public class Field92N
extends Field
implements Serializable, CurrencyContainer, AmountContainer, GenericField
```
Field 92N

validation pattern: :4!c//<AMOUNT>15/<CUR><AMOUNT>15
parser pattern: :S//N/SN
components pattern: SNCN

Components Data types
- component1: String
- component2: Number
- component3: Currency
- component4: Number
NOTE: this source code has been generated from template
Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`AMOUNT` Component number for the Amount subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`CURRENCY` Component number for the Currency subfield
`static String`	`F_92N` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 92N
`static String`	`PARSER_PATTERN`
`static Integer`	`QUALIFIER` Component number for the Qualifier subfield
`static Integer`	`QUANTITY` Component number for the Quantity subfield

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
Constructor and Description

Field92N()
Default constructor

Field92N(String value)
Creates the field parsing the parameter value into fields' components

Constructors
Constructor and Description
`Field92N()` Default constructor
`Field92N(String value)` Creates the field parsing the parameter value into fields' components

Method Summary

Methods
Modifier and Type	Method and Description
`BigDecimal`	`amount()` Get the first amount in this field.
`List<BigDecimal>`	`amounts()`
`String`	`componentsPattern()`
`int`	`componentsSize()` Returns the defined amount of components. This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
`List<Currency>`	`currencies()` Utility method that creates a Currency for every string returned by `CurrencyContainer.currencyStrings()`
`Currency`	`currency()` Analog to `CurrencyContainer.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
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field92N`	`get(SwiftMessage msg)` Get the first instance of Field92N in the given message.
`static Field92N`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field92N>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field92N in the given message an empty list is returned if none found.
`static List<Field92N>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field92N from the given block an empty list is returned if none found.
`String`	`getAmount()` Get the Amount (component4).
`Number`	`getAmountAsNumber()` Get the Amount (component4) as Number
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`String`	`getComponent3()` Get the component3
`Currency`	`getComponent3AsCurrency()` Get the component3 as Currency
`String`	`getComponent4()` Get the component4
`Number`	`getComponent4AsNumber()` Get the component4 as Number
`String`	`getConditionalQualifier()` Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
`String`	`getCurrency()` Get the Currency (component3).
`Currency`	`getCurrencyAsCurrency()` Get the Currency (component3) as Currency
`String`	`getDSS()` Returns the issuer code (or Data Source Scheme or DSS).
`String`	`getName()` Deprecated. use constant Field92N
`String`	`getQualifier()` Get the Qualifier (component1).
`String`	`getQuantity()` Get the Quantity (component2).
`Number`	`getQuantityAsNumber()` Get the Quantity (component2) as Number
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`void`	`initializeCurrencies(Currency cur)`
`void`	`initializeCurrencies(String cur)` set the currency of this field.
`boolean`	`isDSSPresent()` Checks if the issuer code (or Data Source Scheme or DSS) is present.
`boolean`	`isGeneric()` Returns true if the field is a GENERIC FIELD as specified by the standard.
`boolean`	`isOptional(int component)` Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message. Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
`static Field92N`	`newInstance(Field92N source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field92N`	`setAmount(Number component4)` Set the Amount (component4) as Number
`Field92N`	`setAmount(String component4)` Set the Amount (component4).
`Field92N`	`setComponent1(String component1)` Set the component1.
`Field92N`	`setComponent2(Number component2)` Set the component2.
`Field92N`	`setComponent2(String component2)` Set the component2.
`Field92N`	`setComponent3(Currency component3)` Set the component3.
`Field92N`	`setComponent3(String component3)` Set the component3.
`Field92N`	`setComponent4(Number component4)` Set the component4.
`Field92N`	`setComponent4(String component4)` Set the component4.
`Field92N`	`setCurrency(Currency component3)` Set the Currency (component3) as Currency
`Field92N`	`setCurrency(String component3)` Set the Currency (component3).
`Field92N`	`setQualifier(String component1)` Set the Qualifier (component1).
`Field92N`	`setQuantity(Number component2)` Set the Quantity (component2) as Number
`Field92N`	`setQuantity(String component2)` Set the Quantity (component2).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.

Methods inherited from class com.prowidesoftware.swift.model.field.Field
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Constant with the field name 92N
    
    See Also:
    Constant Field Values
  - F_92N
```
public static final String F_92N
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    See Also:
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    See Also:
    Constant Field Values
  - QUALIFIER
```
public static final Integer QUALIFIER
```
    Component number for the Qualifier subfield
  - QUANTITY
```
public static final Integer QUANTITY
```
    Component number for the Quantity subfield
  - CURRENCY
```
public static final Integer CURRENCY
```
    Component number for the Currency subfield
  - AMOUNT
```
public static final Integer AMOUNT
```
    Component number for the Amount subfield
- Constructor Detail
  - Field92N
```
public Field92N()
```
    Default constructor
  - Field92N
```
public Field92N(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field92N newInstance(Field92N source)
```
    Copy constructor.
    Initializes the components list with a deep copy of the source components list.
    
    Parameters:
    source - a field instance to copy
    Since:
    
    7.7
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Overrides:
    
    getValue in class Field
    
    Returns:
    SWIFT formatted value
  - tag
```
public static Tag tag(String value)
```
    Create a Tag with this field name and the given value. Shorthand for new Tag(NAME, value)
    
    Since:
    
    7.5
    
    See Also:
    NAME
  - emptyTag
```
public static Tag emptyTag()
```
    Create a Tag with this field name and an empty string as value Shorthand for new Tag(NAME, "")
    
    Since:
    
    7.5
    
    See Also:
    NAME
  - getComponent1
```
public String getComponent1()
```
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsString
```
@Deprecated
public String getComponent1AsString()
```
    Deprecated.
    
    Same as getComponent(1)
  - getQualifier
```
public String getQualifier()
```
    Get the Qualifier (component1).
    
    Returns:
    the Qualifier from component1
  - setComponent1
```
public Field92N setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setQualifier
```
public Field92N setQualifier(String component1)
```
    Set the Qualifier (component1).
    
    Parameters:
    component1 - the Qualifier to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsNumber
```
public Number getComponent2AsNumber()
```
    Get the component2 as Number
    
    Returns:
    the component2 converted to Number or null if cannot be converted
  - getQuantity
```
public String getQuantity()
```
    Get the Quantity (component2).
    
    Returns:
    the Quantity from component2
  - getQuantityAsNumber
```
public Number getQuantityAsNumber()
```
    Get the Quantity (component2) as Number
    
    Returns:
    the Quantity from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field92N setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field92N setComponent2(Number component2)
```
    Set the component2.
    
    Parameters:
    component2 - the Number with the component2 content to set
  - setQuantity
```
public Field92N setQuantity(String component2)
```
    Set the Quantity (component2).
    
    Parameters:
    component2 - the Quantity to set
  - setQuantity
```
public Field92N setQuantity(Number component2)
```
    Set the Quantity (component2) as Number
    
    Parameters:
    component2 - Number with the Quantity content to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsCurrency
```
public Currency getComponent3AsCurrency()
```
    Get the component3 as Currency
    
    Returns:
    the component3 converted to Currency or null if cannot be converted
  - getCurrency
```
public String getCurrency()
```
    Get the Currency (component3).
    
    Returns:
    the Currency from component3
  - getCurrencyAsCurrency
```
public Currency getCurrencyAsCurrency()
```
    Get the Currency (component3) as Currency
    
    Returns:
    the Currency from component3 converted to Currency or null if cannot be converted
  - setComponent3
```
public Field92N setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field92N setComponent3(Currency component3)
```
    Set the component3.
    
    Parameters:
    component3 - the Currency with the component3 content to set
  - setCurrency
```
public Field92N setCurrency(String component3)
```
    Set the Currency (component3).
    
    Parameters:
    component3 - the Currency to set
  - setCurrency
```
public Field92N setCurrency(Currency component3)
```
    Set the Currency (component3) as Currency
    
    Parameters:
    component3 - Currency with the Currency content to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsNumber
```
public Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    the component4 converted to Number or null if cannot be converted
  - getAmount
```
public String getAmount()
```
    Get the Amount (component4).
    
    Returns:
    the Amount from component4
  - getAmountAsNumber
```
public Number getAmountAsNumber()
```
    Get the Amount (component4) as Number
    
    Returns:
    the Amount from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field92N setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field92N setComponent4(Number component4)
```
    Set the component4.
    
    Parameters:
    component4 - the Number with the component4 content to set
  - setAmount
```
public Field92N setAmount(String component4)
```
    Set the Amount (component4).
    
    Parameters:
    component4 - the Amount to set
  - setAmount
```
public Field92N setAmount(Number component4)
```
    Set the Amount (component4) as Number
    
    Parameters:
    component4 - Number with the Amount content to set
  - currencyStrings
```
public List<String> currencyStrings()
```
    Description copied from interface: CurrencyContainer
    
    Get a list of strings of currencies present in this field
    
    Specified by:
    
    currencyStrings in interface CurrencyContainer
    
    Returns:
    a list, with zero or more currencies in this field.
  - currencies
```
public List<Currency> currencies()
```
    Description copied from interface: CurrencyContainer
    
    Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()
    
    Specified by:
    
    currencies in interface CurrencyContainer
  - currency
```
public Currency currency()
```
    Description copied from interface: CurrencyContainer
    
    Analog to CurrencyContainer.currencyString()
    
    Specified by:
    
    currency in interface CurrencyContainer
    
    See Also:
    CurrencyContainer.currencyStrings(), CurrencyContainer.currencyString()
  - currencyString
```
public String currencyString()
```
    Description copied from interface: CurrencyContainer
    
    Get the single currency contained in this field.
    
    Specified by:
    
    currencyString in interface CurrencyContainer
    
    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.
  - initializeCurrencies
```
public void initializeCurrencies(String cur)
```
    Description copied from interface: CurrencyContainer
    
    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.
    
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
  - initializeCurrencies
```
public void initializeCurrencies(Currency cur)
```
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
    
    See Also:
    CurrencyContainer.initializeCurrencies(String)
  - amounts
```
public List<BigDecimal> amounts()
```
  - amount
```
public BigDecimal amount()
```
    Description copied from interface: AmountContainer
    
    Get the first amount in this field.
    
    Specified by:
    
    amount in interface AmountContainer
  - isOptional
```
public boolean isOptional(int component)
```
    Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message.
    Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
    
    Specified by:
    
    isOptional in class Field
    
    Parameters:
    component - component number, first component of a field is referenced as 1
    
    Returns:
    true if the component is optional for this field, false otherwise
  - isGeneric
```
public boolean isGeneric()
```
    Returns true if the field is a GENERIC FIELD as specified by the standard.
    
    Specified by:
    
    isGeneric in class Field
    
    Returns:
    true if the field is generic, false otherwise
  - getDSS
```
public String getDSS()
```
    Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.
    
    Specified by:
    
    getDSS in interface GenericField
    
    Overrides:
    
    getDSS in class Field
    
    Returns:
    DSS component value or null if the DSS is not set or not available for this field.
  - isDSSPresent
```
public boolean isDSSPresent()
```
    Checks if the issuer code (or Data Source Scheme or DSS) is present.
    
    Specified by:
    
    isDSSPresent in interface GenericField
    
    Overrides:
    
    isDSSPresent in class Field
    
    Returns:
    true if DSS is present, false otherwise.
    See Also:
    getDSS()
  - getConditionalQualifier
```
public String getConditionalQualifier()
```
    Gets the conditional qualifier.
    The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
    
    Specified by:
    
    getConditionalQualifier in interface GenericField
    
    Overrides:
    
    getConditionalQualifier in class Field
    
    Returns:
    for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.
  - componentsPattern
```
public String componentsPattern()
```
    Specified by:
    
    componentsPattern in interface PatternContainer
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Deprecated. use constant Field92N
    
    Description copied from class: Field
    
    Returns the field's name composed by the field number and the letter option (if any)
    
    Specified by:
    
    getName in class Field
  - get
```
public static Field92N get(SwiftTagListBlock block)
```
    Get the first occurrence form the tag list or null if not found.
    
    Parameters:
    block - may be null or empty
    
    Returns:
    null if not found o block is null or empty
  - get
```
public static Field92N get(SwiftMessage msg)
```
    Get the first instance of Field92N in the given message.
    
    Parameters:
    msg - may be empty or null
    
    Returns:
    null if not found or msg is empty or null
    See Also:
    get(SwiftTagListBlock)
  - getAll
```
public static List<Field92N> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field92N in the given message an empty list is returned if none found.
    
    Parameters:
    msg - may be empty or null in which case an empty list is returned
    See Also:
    getAll(SwiftTagListBlock)
  - getAll
```
public static List<Field92N> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field92N from the given block an empty list is returned if none found.
    
    Parameters:
    block - may be empty or null in which case an empty list is returned
  - componentsSize
```
public int componentsSize()
```
    Returns the defined amount of components.
    This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
    
    Specified by:
    
    componentsSize in class Field
    
    Since:
    
    7.7

Class Field92N

Components Data types

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.field.Field

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.field.Field

Methods inherited from class java.lang.Object

Field Detail

NAME

F_92N

PARSER_PATTERN

COMPONENTS_PATTERN

QUALIFIER

QUANTITY

CURRENCY

AMOUNT

Constructor Detail

Field92N

Field92N

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getQualifier

setComponent1

setQualifier

getComponent2

getComponent2AsNumber

getQuantity

getQuantityAsNumber

setComponent2

setComponent2

setQuantity

setQuantity

getComponent3

getComponent3AsCurrency

getCurrency

getCurrencyAsCurrency

setComponent3

setComponent3

setCurrency

setCurrency

getComponent4

getComponent4AsNumber

getAmount

getAmountAsNumber

setComponent4

setComponent4

setAmount

setAmount

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

amounts

amount

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize