com.prowidesoftware.swift.model.field
Class Field93D

java.lang.Object
  com.prowidesoftware.swift.model.field.Field
      com.prowidesoftware.swift.model.field.Field93D

All Implemented Interfaces:

AmountContainer, GenericField, PatternContainer, java.io.Serializable

public class Field93D
extends Field
implements java.io.Serializable, AmountContainer, GenericField

Field 93D

validation pattern: :4!c//[N]15
parser pattern: :S//[c]N
components pattern: SSN

Components Data types

• component1: String
• component2: String
• component3: Number

NOTE: this source code has been generated.

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

static java.lang.String	COMPONENTS_PATTERN
static java.lang.String	NAME
static java.lang.String	PARSER_PATTERN

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

components

Constructor Summary

Field93D()
Default constructor

Field93D(java.lang.String value)
Creates the field parsing the parameter value into fields' components

Method Summary

java.math.BigDecimal	amount() Get the first amount in this field.
java.util.List<java.math.BigDecimal>	amounts()
java.lang.String	componentsPattern()
java.lang.String	getAmount() Get the Amount (component3).
java.lang.Number	getAmountAsNumber() Get the Amount (component3) as Number
java.lang.String	getComponent1() Get the component1
java.lang.String	getComponent1AsString() Deprecated.
java.lang.String	getComponent2() Get the component2
java.lang.String	getComponent2AsString() Deprecated.
java.lang.String	getComponent3() Get the component3
java.lang.Number	getComponent3AsNumber() Get the component3 as Number
java.lang.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.
java.lang.String	getDSS() Returns the issuer code (or Data Source Scheme or DSS).
java.lang.String	getQualifier() Get the Qualifier (component1).
java.lang.String	getSign() Get the Sign (component2).
java.lang.String	getValue() Serializes the fields' components into the single string value (SWIFT format)
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.
java.lang.String	parserPattern()
void	setAmount(java.lang.Number component3) Set the Amount (component3) as Number
void	setAmount(java.lang.String component3) Set the Amount (component3).
void	setComponent1(java.lang.String component1) Set the component1.
void	setComponent2(java.lang.String component2) Set the component2.
void	setComponent3(java.lang.Number component3) Set the component3.
void	setComponent3(java.lang.String component3) Set the component3.
void	setQualifier(java.lang.String component1) Set the Qualifier (component1).
void	setSign(java.lang.String component2) Set the Sign (component2).

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

appendInLines, appendInLines, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, isEmpty, joinComponents, joinComponents, joinComponents, joinComponents, setComponent, setComponents, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PARSER_PATTERN

public static final java.lang.String PARSER_PATTERN

See Also:

Constant Field Values

COMPONENTS_PATTERN

public static final java.lang.String COMPONENTS_PATTERN

See Also:

Constant Field Values

Constructor Detail

Field93D

public Field93D()

Default constructor

Field93D

public Field93D(java.lang.String value)

Creates the field parsing the parameter value into fields' components

Parameters:

value -

Method Detail

getValue

public java.lang.String getValue()

Serializes the fields' components into the single string value (SWIFT format)

Overrides:

getValue in class Field

Returns:

SWIFT formatted value

getComponent1

public java.lang.String getComponent1()

Get the component1

Returns:

the component1

getComponent1AsString

@Deprecated
public java.lang.String getComponent1AsString()

Deprecated.

Same as getComponent(1)

getQualifier

public java.lang.String getQualifier()

Get the Qualifier (component1).

Returns:

the Qualifier from component1

setComponent1

public void setComponent1(java.lang.String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setQualifier

public void setQualifier(java.lang.String component1)

Set the Qualifier (component1).

Parameters:

component1 - the Qualifier to set

getComponent2

public java.lang.String getComponent2()

Get the component2

Returns:

the component2

getComponent2AsString

@Deprecated
public java.lang.String getComponent2AsString()

Deprecated.

Same as getComponent(2)

getSign

public java.lang.String getSign()

Get the Sign (component2).

Returns:

the Sign from component2

setComponent2

public void setComponent2(java.lang.String component2)

Set the component2.

Parameters:

component2 - the component2 to set

setSign

public void setSign(java.lang.String component2)

Set the Sign (component2).

Parameters:

component2 - the Sign to set

getComponent3

public java.lang.String getComponent3()

Get the component3

Returns:

the component3

getComponent3AsNumber

public java.lang.Number getComponent3AsNumber()

Get the component3 as Number

Returns:

the component3 converted to Number or null if cannot be converted

getAmount

public java.lang.String getAmount()

Get the Amount (component3).

Returns:

the Amount from component3

getAmountAsNumber

public java.lang.Number getAmountAsNumber()

Get the Amount (component3) as Number

Returns:

the Amount from component3 converted to Number or null if cannot be converted

setComponent3

public void setComponent3(java.lang.String component3)

Set the component3.

Parameters:

component3 - the component3 to set

setComponent3

public void setComponent3(java.lang.Number component3)

Set the component3.

Parameters:

component3 - the Number with the component3 content to set

setAmount

public void setAmount(java.lang.String component3)

Set the Amount (component3).

Parameters:

component3 - the Amount to set

setAmount

public void setAmount(java.lang.Number component3)

Set the Amount (component3) as Number

Parameters:

component3 - Number with the Amount content to set

amounts

public java.util.List<java.math.BigDecimal> amounts()

amount

public java.math.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 java.lang.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 java.lang.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 java.lang.String componentsPattern()

Specified by:

componentsPattern in interface PatternContainer

parserPattern

public java.lang.String parserPattern()

Specified by:

parserPattern in interface PatternContainer