com.prowidesoftware.swift.model.field
Class Field88A

java.lang.Object
  extended by com.prowidesoftware.swift.model.field.Field
      extended by com.prowidesoftware.swift.model.field.Field88A
All Implemented Interfaces:
BICContainer, PatternContainer, java.io.Serializable

public class Field88A
extends Field
implements java.io.Serializable, BICContainer

Field 88A

validation pattern: [[/][/34x]$]|
parser pattern: [[/c][/S]$]S
components pattern: SSB

Components Data types

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
Field88A()
          Default constructor
Field88A(java.lang.String value)
          Creates the field parsing the parameter value into fields' components
 
Method Summary
 java.util.List<BIC> bics()
          Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
 java.util.List<java.lang.String> bicStrings()
          Get a list of strings of BICs present in this field
 java.lang.String componentsPattern()
           
 java.lang.String getAccount()
          Get the Account (component2).
 java.lang.String getBIC()
          Get the BIC (component3).
 BIC getBICAsBIC()
          Get the BIC (component3) as BIC
 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
 BIC getComponent3AsBIC()
          Get the component3 as BIC
 java.lang.String getDCMark()
          Get the D/C Mark (component1).
 java.lang.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.
 java.lang.String parserPattern()
           
 void setAccount(java.lang.String component2)
          Set the Account (component2).
 void setBIC(BIC component3)
          Set the BIC (component3) as BIC
 void setBIC(java.lang.String component3)
          Set the BIC (component3).
 void setComponent1(java.lang.String component1)
          Set the component1.
 void setComponent2(java.lang.String component2)
          Set the component2.
 void setComponent3(BIC component3)
          Set the component3.
 void setComponent3(java.lang.String component3)
          Set the component3.
 void setDCMark(java.lang.String component1)
          Set the D/C Mark (component1).
 
Methods inherited from class com.prowidesoftware.swift.model.field.Field
appendInLines, appendInLines, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, isDSSPresent, 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

Field88A

public Field88A()
Default constructor


Field88A

public Field88A(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)


getDCMark

public java.lang.String getDCMark()
Get the D/C Mark (component1).

Returns:
the D/C Mark from component1

setComponent1

public void setComponent1(java.lang.String component1)
Set the component1.

Parameters:
component1 - the component1 to set

setDCMark

public void setDCMark(java.lang.String component1)
Set the D/C Mark (component1).

Parameters:
component1 - the D/C Mark 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)


getAccount

public java.lang.String getAccount()
Get the Account (component2).

Returns:
the Account from component2

setComponent2

public void setComponent2(java.lang.String component2)
Set the component2.

Parameters:
component2 - the component2 to set

setAccount

public void setAccount(java.lang.String component2)
Set the Account (component2).

Parameters:
component2 - the Account to set

getComponent3

public java.lang.String getComponent3()
Get the component3

Returns:
the component3

getComponent3AsBIC

public BIC getComponent3AsBIC()
Get the component3 as BIC

Returns:
the component3 converted to BIC or null if cannot be converted

getBIC

public java.lang.String getBIC()
Get the BIC (component3).

Returns:
the BIC from component3

getBICAsBIC

public BIC getBICAsBIC()
Get the BIC (component3) as BIC

Returns:
the BIC from component3 converted to BIC 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(BIC component3)
Set the component3.

Parameters:
component3 - the BIC with the component3 content to set

setBIC

public void setBIC(java.lang.String component3)
Set the BIC (component3).

Parameters:
component3 - the BIC to set

setBIC

public void setBIC(BIC component3)
Set the BIC (component3) as BIC

Parameters:
component3 - BIC with the BIC content to set

bics

public java.util.List<BIC> bics()
Description copied from interface: BICContainer
Utility method that creates a BIC for every string returned by BICContainer.bicStrings()

Specified by:
bics in interface BICContainer

bicStrings

public java.util.List<java.lang.String> bicStrings()
Description copied from interface: BICContainer
Get a list of strings of BICs present in this field

Specified by:
bicStrings in interface BICContainer
Returns:
a list, with zero or more BICs in this field.

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 java.lang.String componentsPattern()
Specified by:
componentsPattern in interface PatternContainer

parserPattern

public java.lang.String parserPattern()
Specified by:
parserPattern in interface PatternContainer