Field37H (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, PatternContainer, Serializable
```
public class Field37H
extends Field
implements Serializable, AmountContainer
```
Field 37H

validation pattern: <DC><AMOUNT>12
parser pattern: SN
components pattern: SN

Components Data types
- component1: String
- component2: 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 String`	`COMPONENTS_PATTERN`
`static Integer`	`DC_MARK` Component number for the D/C Mark subfield
`static String`	`F_37H` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 37H
`static String`	`PARSER_PATTERN`
`static Integer`	`RATE` Component number for the Rate subfield

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

Constructor Summary

Constructors
Constructor and Description

Field37H()
Default constructor

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

Constructors
Constructor and Description
`Field37H()` Default constructor
`Field37H(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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field37H`	`get(SwiftMessage msg)` Get the first instance of Field37H in the given message.
`static Field37H`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field37H>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field37H in the given message an empty list is returned if none found.
`static List<Field37H>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field37H from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`String`	`getDCMark()` Get the D/C Mark (component1).
`String`	`getName()` Deprecated. use constant Field37H
`String`	`getRate()` Get the Rate (component2).
`Number`	`getRateAsNumber()` Get the Rate (component2) as Number
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`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 Field37H`	`newInstance(Field37H source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field37H`	`setComponent1(String component1)` Set the component1.
`Field37H`	`setComponent2(Number component2)` Set the component2.
`Field37H`	`setComponent2(String component2)` Set the component2.
`Field37H`	`setDCMark(String component1)` Set the D/C Mark (component1).
`Field37H`	`setRate(Number component2)` Set the Rate (component2) as Number
`Field37H`	`setRate(String component2)` Set the Rate (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, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isDSSPresent, 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 37H
    
    See Also:
    Constant Field Values
  - F_37H
```
public static final String F_37H
```
    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
  - DC_MARK
```
public static final Integer DC_MARK
```
    Component number for the D/C Mark subfield
  - RATE
```
public static final Integer RATE
```
    Component number for the Rate subfield
- Constructor Detail
  - Field37H
```
public Field37H()
```
    Default constructor
  - Field37H
```
public Field37H(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field37H newInstance(Field37H 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)
  - getDCMark
```
public String getDCMark()
```
    Get the D/C Mark (component1).
    
    Returns:
    the D/C Mark from component1
  - setComponent1
```
public Field37H setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setDCMark
```
public Field37H setDCMark(String component1)
```
    Set the D/C Mark (component1).
    
    Parameters:
    component1 - the D/C Mark 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
  - getRate
```
public String getRate()
```
    Get the Rate (component2).
    
    Returns:
    the Rate from component2
  - getRateAsNumber
```
public Number getRateAsNumber()
```
    Get the Rate (component2) as Number
    
    Returns:
    the Rate from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field37H setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field37H setComponent2(Number component2)
```
    Set the component2.
    
    Parameters:
    component2 - the Number with the component2 content to set
  - setRate
```
public Field37H setRate(String component2)
```
    Set the Rate (component2).
    
    Parameters:
    component2 - the Rate to set
  - setRate
```
public Field37H setRate(Number component2)
```
    Set the Rate (component2) as Number
    
    Parameters:
    component2 - Number with the Rate content to set
  - 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
  - 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 Field37H
    
    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 Field37H 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 Field37H get(SwiftMessage msg)
```
    Get the first instance of Field37H 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<Field37H> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field37H 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<Field37H> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field37H 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 Field37H

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_37H

PARSER_PATTERN

COMPONENTS_PATTERN

DC_MARK

RATE

Constructor Detail

Field37H

Field37H

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getDCMark

setComponent1

setDCMark

getComponent2

getComponent2AsNumber

getRate

getRateAsNumber

setComponent2

setComponent2

setRate

setRate

amounts

amount

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize