com.prowidesoftware.swift.model.field
Class Field61

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

public class Field61
extends Field
implements java.io.Serializable

Field 61

validation pattern: CUSTOM
parser pattern: CUSTOM
components pattern: EFSSNSSSS

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
Field61()
          Default constructor
Field61(java.lang.String value)
          Creates the field parsing the parameter value into fields' components
 
Method Summary
 java.lang.String componentsPattern()
           
 java.lang.String getAmount()
          Get the Amount (component5).
 java.lang.Number getAmountAsNumber()
          Get the Amount (component5) as Number
 java.lang.String getComponent1()
          Get the component1
 java.util.Calendar getComponent1AsCalendar()
          Get the component1 as Calendar
 java.lang.String getComponent2()
          Get the component2
 java.util.Calendar getComponent2AsCalendar()
          Get the component2 as Calendar
 java.lang.String getComponent3()
          Get the component3
 java.lang.String getComponent3AsString()
          Deprecated. 
 java.lang.String getComponent4()
          Get the component4
 java.lang.String getComponent4AsString()
          Deprecated. 
 java.lang.String getComponent5()
          Get the component5
 java.lang.Number getComponent5AsNumber()
          Get the component5 as Number
 java.lang.String getComponent6()
          Get the component6
 java.lang.String getComponent6AsString()
          Deprecated. 
 java.lang.String getComponent7()
          Get the component7
 java.lang.String getComponent7AsString()
          Deprecated. 
 java.lang.String getComponent8()
          Get the component8
 java.lang.String getComponent8AsString()
          Deprecated. 
 java.lang.String getComponent9()
          Get the component9
 java.lang.String getComponent9AsString()
          Deprecated. 
 java.lang.String getDCMark()
          Get the D/C Mark (component3).
 java.lang.String getEntryDate()
          Get the Entry Date (component2).
 java.util.Calendar getEntryDateAsCalendar()
          Get the Entry Date (component2) as Calendar
 java.lang.String getFundsCode()
          Get the Funds Code (component4).
 java.lang.String getReferenceForTheAccountOwner()
          Get the Reference For The Account Owner (component7).
 java.lang.String getReferenceOfTheAccountServicingInstitution()
          Get the Reference Of The Account Servicing Institution (component8).
 java.lang.String getSupplementaryDetails()
          Get the Supplementary Details (component9).
 java.lang.String getTransactionType()
          Get the Transaction Type (component6).
 java.lang.String getValue()
          Serializes the fields' components into the single string value (SWIFT format)
 java.lang.String getValueDate()
          Get the Value Date (component1).
 java.util.Calendar getValueDateAsCalendar()
          Get the Value Date (component1) as Calendar
 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.
protected  void parseCustom(java.lang.String value)
          Custom parser for Field61.
Uses semantic information to split components 3 and 4 (assuming component 3 can only be D, C, RD, RC).
 java.lang.String parserPattern()
           
 void setAmount(java.lang.Number component5)
          Set the Amount (component5) as Number
 void setAmount(java.lang.String component5)
          Set the Amount (component5).
 void setComponent1(java.util.Calendar component1)
          Set the component1.
 void setComponent1(java.lang.String component1)
          Set the component1.
 void setComponent2(java.util.Calendar component2)
          Set the component2.
 void setComponent2(java.lang.String component2)
          Set the component2.
 void setComponent3(java.lang.String component3)
          Set the component3.
 void setComponent4(java.lang.String component4)
          Set the component4.
 void setComponent5(java.lang.Number component5)
          Set the component5.
 void setComponent5(java.lang.String component5)
          Set the component5.
 void setComponent6(java.lang.String component6)
          Set the component6.
 void setComponent7(java.lang.String component7)
          Set the component7.
 void setComponent8(java.lang.String component8)
          Set the component8.
 void setComponent9(java.lang.String component9)
          Set the component9.
 void setDCMark(java.lang.String component3)
          Set the D/C Mark (component3).
 void setEntryDate(java.util.Calendar component2)
          Set the Entry Date (component2) as Calendar
 void setEntryDate(java.lang.String component2)
          Set the Entry Date (component2).
 void setFundsCode(java.lang.String component4)
          Set the Funds Code (component4).
 void setReferenceForTheAccountOwner(java.lang.String component7)
          Set the Reference For The Account Owner (component7).
 void setReferenceOfTheAccountServicingInstitution(java.lang.String component8)
          Set the Reference Of The Account Servicing Institution (component8).
 void setSupplementaryDetails(java.lang.String component9)
          Set the Supplementary Details (component9).
 void setTransactionType(java.lang.String component6)
          Set the Transaction Type (component6).
 void setValueDate(java.util.Calendar component1)
          Set the Value Date (component1) as Calendar
 void setValueDate(java.lang.String component1)
          Set the Value Date (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

Field61

public Field61()
Default constructor


Field61

public Field61(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

getComponent1AsCalendar

public java.util.Calendar getComponent1AsCalendar()
Get the component1 as Calendar

Returns:
the component1 converted to Calendar or null if cannot be converted

getValueDate

public java.lang.String getValueDate()
Get the Value Date (component1).

Returns:
the Value Date from component1

getValueDateAsCalendar

public java.util.Calendar getValueDateAsCalendar()
Get the Value Date (component1) as Calendar

Returns:
the Value Date from component1 converted to Calendar or null if cannot be converted

setComponent1

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

Parameters:
component1 - the component1 to set

setComponent1

public void setComponent1(java.util.Calendar component1)
Set the component1.

Parameters:
component1 - the Calendar with the component1 content to set

setValueDate

public void setValueDate(java.lang.String component1)
Set the Value Date (component1).

Parameters:
component1 - the Value Date to set

setValueDate

public void setValueDate(java.util.Calendar component1)
Set the Value Date (component1) as Calendar

Parameters:
component1 - Calendar with the Value Date content to set

getComponent2

public java.lang.String getComponent2()
Get the component2

Returns:
the component2

getComponent2AsCalendar

public java.util.Calendar getComponent2AsCalendar()
Get the component2 as Calendar

Returns:
the component2 converted to Calendar or null if cannot be converted

getEntryDate

public java.lang.String getEntryDate()
Get the Entry Date (component2).

Returns:
the Entry Date from component2

getEntryDateAsCalendar

public java.util.Calendar getEntryDateAsCalendar()
Get the Entry Date (component2) as Calendar

Returns:
the Entry Date from component2 converted to Calendar or null if cannot be converted

setComponent2

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

Parameters:
component2 - the component2 to set

setComponent2

public void setComponent2(java.util.Calendar component2)
Set the component2.

Parameters:
component2 - the Calendar with the component2 content to set

setEntryDate

public void setEntryDate(java.lang.String component2)
Set the Entry Date (component2).

Parameters:
component2 - the Entry Date to set

setEntryDate

public void setEntryDate(java.util.Calendar component2)
Set the Entry Date (component2) as Calendar

Parameters:
component2 - Calendar with the Entry Date content to set

getComponent3

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

Returns:
the component3

getComponent3AsString

@Deprecated
public java.lang.String getComponent3AsString()
Deprecated. 

Same as getComponent(3)


getDCMark

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

Returns:
the D/C Mark from component3

setComponent3

public void setComponent3(java.lang.String component3)
Set the component3.

Parameters:
component3 - the component3 to set

setDCMark

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

Parameters:
component3 - the D/C Mark to set

getComponent4

public java.lang.String getComponent4()
Get the component4

Returns:
the component4

getComponent4AsString

@Deprecated
public java.lang.String getComponent4AsString()
Deprecated. 

Same as getComponent(4)


getFundsCode

public java.lang.String getFundsCode()
Get the Funds Code (component4).

Returns:
the Funds Code from component4

setComponent4

public void setComponent4(java.lang.String component4)
Set the component4.

Parameters:
component4 - the component4 to set

setFundsCode

public void setFundsCode(java.lang.String component4)
Set the Funds Code (component4).

Parameters:
component4 - the Funds Code to set

getComponent5

public java.lang.String getComponent5()
Get the component5

Returns:
the component5

getComponent5AsNumber

public java.lang.Number getComponent5AsNumber()
Get the component5 as Number

Returns:
the component5 converted to Number or null if cannot be converted

getAmount

public java.lang.String getAmount()
Get the Amount (component5).

Returns:
the Amount from component5

getAmountAsNumber

public java.lang.Number getAmountAsNumber()
Get the Amount (component5) as Number

Returns:
the Amount from component5 converted to Number or null if cannot be converted

setComponent5

public void setComponent5(java.lang.String component5)
Set the component5.

Parameters:
component5 - the component5 to set

setComponent5

public void setComponent5(java.lang.Number component5)
Set the component5.

Parameters:
component5 - the Number with the component5 content to set

setAmount

public void setAmount(java.lang.String component5)
Set the Amount (component5).

Parameters:
component5 - the Amount to set

setAmount

public void setAmount(java.lang.Number component5)
Set the Amount (component5) as Number

Parameters:
component5 - Number with the Amount content to set

getComponent6

public java.lang.String getComponent6()
Get the component6

Returns:
the component6

getComponent6AsString

@Deprecated
public java.lang.String getComponent6AsString()
Deprecated. 

Same as getComponent(6)


getTransactionType

public java.lang.String getTransactionType()
Get the Transaction Type (component6).

Returns:
the Transaction Type from component6

setComponent6

public void setComponent6(java.lang.String component6)
Set the component6.

Parameters:
component6 - the component6 to set

setTransactionType

public void setTransactionType(java.lang.String component6)
Set the Transaction Type (component6).

Parameters:
component6 - the Transaction Type to set

getComponent7

public java.lang.String getComponent7()
Get the component7

Returns:
the component7

getComponent7AsString

@Deprecated
public java.lang.String getComponent7AsString()
Deprecated. 

Same as getComponent(7)


getReferenceForTheAccountOwner

public java.lang.String getReferenceForTheAccountOwner()
Get the Reference For The Account Owner (component7).

Returns:
the Reference For The Account Owner from component7

setComponent7

public void setComponent7(java.lang.String component7)
Set the component7.

Parameters:
component7 - the component7 to set

setReferenceForTheAccountOwner

public void setReferenceForTheAccountOwner(java.lang.String component7)
Set the Reference For The Account Owner (component7).

Parameters:
component7 - the Reference For The Account Owner to set

getComponent8

public java.lang.String getComponent8()
Get the component8

Returns:
the component8

getComponent8AsString

@Deprecated
public java.lang.String getComponent8AsString()
Deprecated. 

Same as getComponent(8)


getReferenceOfTheAccountServicingInstitution

public java.lang.String getReferenceOfTheAccountServicingInstitution()
Get the Reference Of The Account Servicing Institution (component8).

Returns:
the Reference Of The Account Servicing Institution from component8

setComponent8

public void setComponent8(java.lang.String component8)
Set the component8.

Parameters:
component8 - the component8 to set

setReferenceOfTheAccountServicingInstitution

public void setReferenceOfTheAccountServicingInstitution(java.lang.String component8)
Set the Reference Of The Account Servicing Institution (component8).

Parameters:
component8 - the Reference Of The Account Servicing Institution to set

getComponent9

public java.lang.String getComponent9()
Get the component9

Returns:
the component9

getComponent9AsString

@Deprecated
public java.lang.String getComponent9AsString()
Deprecated. 

Same as getComponent(9)


getSupplementaryDetails

public java.lang.String getSupplementaryDetails()
Get the Supplementary Details (component9).

Returns:
the Supplementary Details from component9

setComponent9

public void setComponent9(java.lang.String component9)
Set the component9.

Parameters:
component9 - the component9 to set

setSupplementaryDetails

public void setSupplementaryDetails(java.lang.String component9)
Set the Supplementary Details (component9).

Parameters:
component9 - the Supplementary Details to set

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

parseCustom

protected void parseCustom(java.lang.String value)
Custom parser for Field61.
Uses semantic information to split components 3 and 4 (assuming component 3 can only be D, C, RD, RC). It also splits VAR-SEQU-1 into components 7 and 8.

Thanks to Mark Karatovic for his contribution.