Class Field61
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field61
-
- All Implemented Interfaces:
JsonSerializable
,AmountContainer
,DateContainer
,MultiLineField
,PatternContainer
,java.io.Serializable
@Generated public class Field61 extends Field implements java.io.Serializable, AmountContainer, DateContainer, MultiLineField
SWIFT MT Field 61.Model and parser for field 61 of a SWIFT MT message.
Subfields (components) Data types
- Component 1: ValueDate:
Calendar
- Component 2: EntryDate:
Calendar
- Component 3: DebitCreditMark:
String
- Component 4: FundsCode:
String
- Component 5: Amount:
BigDecimal
- Component 6: TransactionType:
String
- Component 7: IdentificationCode:
String
- Component 8: ReferenceForTheAccountOwner:
String
- Component 9: ReferenceOfTheAccountServicingInstitution:
String
- Component 10: SupplementaryDetails:
String
Structure definition
- validation pattern:
CUSTOM
- parser pattern:
CUSTOM
- components pattern:
EJSSNSSSSS
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
AMOUNT
Component number for the Amount subfield.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
DATE
Alternative constant name for field's Value Date Component number.static java.lang.Integer
DC_MARK
Deprecated.use #DEBITCREDIT_MARK insteadstatic java.lang.Integer
DEBITCREDIT_MARK
Component number for the Debit/Credit Mark subfield.static java.lang.Integer
ENTRY_DATE
Component number for the Entry Date subfield.static java.lang.String
F_61
Same as NAME, intended to be clear when using static imports.static java.lang.Integer
FUNDS_CODE
Component number for the Funds Code subfield.static java.lang.Integer
IDENTIFICATION_CODE
Component number for the Identification Code subfield.static java.lang.String
NAME
Constant with the field name 61.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static java.lang.Integer
REFERENCE_FOR_THE_ACCOUNT_OWNER
Component number for the Reference For The Account Owner subfield.static java.lang.Integer
REFERENCE_OF_THE_ACCOUNT_SERVICING_INSTITUTION
Component number for the Reference Of The Account Servicing Institution subfield.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.Integer
SUPPLEMENTARY_DETAILS
Component number for the Supplementary Details subfield.static java.lang.Integer
TRANSACTION_TYPE
Component number for the Transaction Type subfield.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
VALUE_DATE
Component number for the Value Date subfield.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field61()
Default constructor.Field61(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field61(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.math.BigDecimal
amount()
Returns the first amounts as BigDecimaljava.util.List<java.math.BigDecimal>
amounts()
Returns the list of all NON-NULL amounts as BigDecimaljava.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
instead.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.java.util.Calendar
date()
Returns the first component that can be converted to a Calendarjava.util.List<java.util.Calendar>
dates()
Returns all components that can be converted to a Calendarstatic Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field61
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field61 object.static Field61
get(SwiftMessage msg)
Gets the first instance of Field61 in the given message.static Field61
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field61>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field61 in the given message an empty list is returned if none found.static java.util.List<Field61>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field61 from the given block an empty list is returned if none found.java.lang.String
getAmount()
Gets the Amount (component 5).java.math.BigDecimal
getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimaljava.lang.Number
getAmountAsNumber()
Deprecated.use #getAmountAsBigDecimal() insteadjava.lang.String
getComponent1()
Gets the component 1 (Value Date).java.lang.String
getComponent10()
Gets the component 10 (Supplementary Details).java.util.Calendar
getComponent1AsCalendar()
Get the component 1 as Calendarjava.lang.String
getComponent2()
Gets the component 2 (Entry Date).java.util.Calendar
getComponent2AsCalendar()
Get the component 2 as Calendarjava.lang.String
getComponent3()
Gets the component 3 (Debit/Credit Mark).java.lang.String
getComponent4()
Gets the component 4 (Funds Code).java.lang.String
getComponent5()
Gets the component 5 (Amount).java.math.BigDecimal
getComponent5AsBigDecimal()
Get the component 5 as BigDecimaljava.lang.Number
getComponent5AsNumber()
Deprecated.use #getComponent5AsBigDecimal() insteadjava.lang.String
getComponent6()
Gets the component 6 (Transaction Type).java.lang.String
getComponent7()
Gets the component 7 (Identification Code).java.lang.String
getComponent8()
Gets the component 8 (Reference For The Account Owner).java.lang.String
getComponent9()
Gets the component 9 (Reference Of The Account Servicing Institution).java.util.List<java.lang.String>
getComponentLabels()
Returns english label for components.protected java.util.Map<java.lang.Integer,java.lang.String>
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.java.lang.String
getDate()
Deprecated.use #getValueDate() insteadjava.util.Calendar
getDateAsCalendar()
Deprecated.use #getValueDateAsCalendar() insteadjava.lang.String
getDCMark()
Deprecated.use #getDebitCreditMark() insteadjava.lang.String
getDebitCreditMark()
Gets the Debit/Credit Mark (component 3).java.lang.String
getEntryDate()
Gets the Entry Date (component 2).java.util.Calendar
getEntryDateAsCalendar()
Get the Entry Date (component 2) as Calendarjava.lang.String
getFundsCode()
Gets the Funds Code (component 4).java.lang.String
getIdentificationCode()
Gets the Identification Code (component 7).protected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getLine(int line)
Returns a specific line from the field's value.java.lang.String
getLine(int line, int offset)
Returns a specific line from the field's value.java.util.List<java.lang.String>
getLines()
Returns the field value split into lines.java.util.List<java.lang.String>
getLines(int offset)
Returns the field value starting at the offset component, split into lines.java.util.List<java.lang.String>
getLinesBetween(int start, int end)
Returns a specific subset of lines from the field's value, given a range.java.util.List<java.lang.String>
getLinesBetween(int start, int end, int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.java.lang.String
getName()
Returns the field's name composed by the field number and the letter option (if any).java.lang.String
getReferenceForTheAccountOwner()
Gets the Reference For The Account Owner (component 8).java.lang.String
getReferenceOfTheAccountServicingInstitution()
Gets the Reference Of The Account Servicing Institution (component 9).java.lang.String
getSupplementaryDetails()
Gets the Supplementary Details (component 10).java.lang.String
getTransactionType()
Gets the Transaction Type (component 6).java.lang.String
getValue()
Serializes the fields' components into the single string value (SWIFT format)java.lang.String
getValueDate()
Gets the Value Date (component 1).java.util.Calendar
getValueDateAsCalendar()
Get the Value Date (component 1) as Calendarjava.lang.String
getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.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 Field61
newInstance(Field61 source)
Copy constructor.void
parse(java.lang.String value)
Parses the parameter value into the internal components structure.protected void
parseCustom(java.lang.String value)
Custom parser for Field61.java.lang.String
parserPattern()
Returns the field parser pattern.Field61
setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field61
setAmount(java.lang.String component5)
Set the Amount (component 5).Field61
setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.Field61
setComponent1(java.lang.String component1)
Set the component 1 (Value Date).Field61
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.Field61
setComponent10(java.lang.String component10)
Set the component 10 (Supplementary Details).Field61
setComponent2(java.lang.String component2)
Set the component 2 (Entry Date).Field61
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.Field61
setComponent3(java.lang.String component3)
Set the component 3 (Debit/Credit Mark).Field61
setComponent4(java.lang.String component4)
Set the component 4 (Funds Code).Field61
setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)Field61
setComponent5(java.lang.String component5)
Set the component 5 (Amount).Field61
setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.Field61
setComponent6(java.lang.String component6)
Set the component 6 (Transaction Type).Field61
setComponent7(java.lang.String component7)
Set the component 7 (Identification Code).Field61
setComponent8(java.lang.String component8)
Set the component 8 (Reference For The Account Owner).Field61
setComponent9(java.lang.String component9)
Set the component 9 (Reference Of The Account Servicing Institution).Field61
setDate(java.lang.String component1)
Deprecated.use #setValueDate(String) insteadField61
setDate(java.util.Calendar component1)
Deprecated.use #setComponent1(java.util.Calendar) insteadField61
setDCMark(java.lang.String component3)
Deprecated.use #setDebitCreditMark(String) insteadField61
setDebitCreditMark(java.lang.String component3)
Set the Debit/Credit Mark (component 3).Field61
setEntryDate(java.lang.String component2)
Set the Entry Date (component 2).Field61
setEntryDate(java.util.Calendar component2)
Set the Entry Date (component 2) from a Calendar object.Field61
setFundsCode(java.lang.String component4)
Set the Funds Code (component 4).Field61
setIdentificationCode(java.lang.String component7)
Set the Identification Code (component 7).Field61
setReferenceForTheAccountOwner(java.lang.String component8)
Set the Reference For The Account Owner (component 8).Field61
setReferenceOfTheAccountServicingInstitution(java.lang.String component9)
Set the Reference Of The Account Servicing Institution (component 9).Field61
setSupplementaryDetails(java.lang.String component10)
Set the Supplementary Details (component 10).Field61
setTransactionType(java.lang.String component6)
Set the Transaction Type (component 6).Field61
setValueDate(java.lang.String component1)
Set the Value Date (component 1).Field61
setValueDate(java.util.Calendar component1)
Set the Value Date (component 1) from a Calendar object.static Tag
tag(java.lang.String value)
Create a Tag with this field name and the given value.java.lang.String
typesPattern()
Returns the field component types pattern.java.lang.String
validatorPattern()
Returns the field validator pattern-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 61.- See Also:
- Constant Field Values
-
F_61
public static final java.lang.String F_61
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
VALUE_DATE
public static final java.lang.Integer VALUE_DATE
Component number for the Value Date subfield.
-
DATE
public static final java.lang.Integer DATE
Alternative constant name for field's Value Date Component number.- See Also:
VALUE_DATE
-
ENTRY_DATE
public static final java.lang.Integer ENTRY_DATE
Component number for the Entry Date subfield.
-
DEBITCREDIT_MARK
public static final java.lang.Integer DEBITCREDIT_MARK
Component number for the Debit/Credit Mark subfield.
-
DC_MARK
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer DC_MARK
Deprecated.use #DEBITCREDIT_MARK instead
-
FUNDS_CODE
public static final java.lang.Integer FUNDS_CODE
Component number for the Funds Code subfield.
-
AMOUNT
public static final java.lang.Integer AMOUNT
Component number for the Amount subfield.
-
TRANSACTION_TYPE
public static final java.lang.Integer TRANSACTION_TYPE
Component number for the Transaction Type subfield.
-
IDENTIFICATION_CODE
public static final java.lang.Integer IDENTIFICATION_CODE
Component number for the Identification Code subfield.
-
REFERENCE_FOR_THE_ACCOUNT_OWNER
public static final java.lang.Integer REFERENCE_FOR_THE_ACCOUNT_OWNER
Component number for the Reference For The Account Owner subfield.
-
REFERENCE_OF_THE_ACCOUNT_SERVICING_INSTITUTION
public static final java.lang.Integer REFERENCE_OF_THE_ACCOUNT_SERVICING_INSTITUTION
Component number for the Reference Of The Account Servicing Institution subfield.
-
SUPPLEMENTARY_DETAILS
public static final java.lang.Integer SUPPLEMENTARY_DETAILS
Component number for the Supplementary Details subfield.
-
-
Constructor Detail
-
Field61
public Field61()
Default constructor. Creates a new field setting all components to null.
-
Field61
public Field61(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field61
public Field61(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field61 newInstance(Field61 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
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew 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 fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
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 classField
- 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.
-
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 classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Value Date).- Returns:
- the component 1
-
getComponent1AsCalendar
public java.util.Calendar getComponent1AsCalendar()
Get the component 1 as Calendar- Returns:
- the component 1 converted to Calendar or null if cannot be converted
-
getValueDate
public java.lang.String getValueDate()
Gets the Value Date (component 1).- Returns:
- the Value Date from component 1
-
getDate
public java.lang.String getDate()
Deprecated.use #getValueDate() insteadAlternative method getter for field's Value Date- Since:
- 9.2.7
-
getValueDateAsCalendar
public java.util.Calendar getValueDateAsCalendar()
Get the Value Date (component 1) as Calendar- Returns:
- the Value Date from component 1 converted to Calendar or null if cannot be converted
-
getDateAsCalendar
public java.util.Calendar getDateAsCalendar()
Deprecated.use #getValueDateAsCalendar() instead- Since:
- 9.2.7
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Entry Date).- Returns:
- the component 2
-
getComponent2AsCalendar
public java.util.Calendar getComponent2AsCalendar()
Get the component 2 as Calendar- Returns:
- the component 2 converted to Calendar or null if cannot be converted
-
getEntryDate
public java.lang.String getEntryDate()
Gets the Entry Date (component 2).- Returns:
- the Entry Date from component 2
-
getEntryDateAsCalendar
public java.util.Calendar getEntryDateAsCalendar()
Get the Entry Date (component 2) as Calendar- Returns:
- the Entry Date from component 2 converted to Calendar or null if cannot be converted
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Debit/Credit Mark).- Returns:
- the component 3
-
getDebitCreditMark
public java.lang.String getDebitCreditMark()
Gets the Debit/Credit Mark (component 3).- Returns:
- the Debit/Credit Mark from component 3
-
getDCMark
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getDCMark()
Deprecated.use #getDebitCreditMark() insteadAlternative DEPRECATED method getter for field's Debit/Credit Mark- Since:
- 9.2.7
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (Funds Code).- Returns:
- the component 4
-
getFundsCode
public java.lang.String getFundsCode()
Gets the Funds Code (component 4).- Returns:
- the Funds Code from component 4
-
getComponent5
public java.lang.String getComponent5()
Gets the component 5 (Amount).- Returns:
- the component 5
-
getComponent5AsBigDecimal
public java.math.BigDecimal getComponent5AsBigDecimal()
Get the component 5 as BigDecimal- Returns:
- the component 5 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getComponent5AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent5AsNumber()
Deprecated.use #getComponent5AsBigDecimal() instead
-
getAmount
public java.lang.String getAmount()
Gets the Amount (component 5).- Returns:
- the Amount from component 5
-
getAmountAsBigDecimal
public java.math.BigDecimal getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimal- Returns:
- the Amount from component 5 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getAmountAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getAmountAsNumber()
Deprecated.use #getAmountAsBigDecimal() instead
-
getComponent6
public java.lang.String getComponent6()
Gets the component 6 (Transaction Type).- Returns:
- the component 6
-
getTransactionType
public java.lang.String getTransactionType()
Gets the Transaction Type (component 6).- Returns:
- the Transaction Type from component 6
-
getComponent7
public java.lang.String getComponent7()
Gets the component 7 (Identification Code).- Returns:
- the component 7
-
getIdentificationCode
public java.lang.String getIdentificationCode()
Gets the Identification Code (component 7).- Returns:
- the Identification Code from component 7
-
getComponent8
public java.lang.String getComponent8()
Gets the component 8 (Reference For The Account Owner).- Returns:
- the component 8
-
getReferenceForTheAccountOwner
public java.lang.String getReferenceForTheAccountOwner()
Gets the Reference For The Account Owner (component 8).- Returns:
- the Reference For The Account Owner from component 8
-
getComponent9
public java.lang.String getComponent9()
Gets the component 9 (Reference Of The Account Servicing Institution).- Returns:
- the component 9
-
getReferenceOfTheAccountServicingInstitution
public java.lang.String getReferenceOfTheAccountServicingInstitution()
Gets the Reference Of The Account Servicing Institution (component 9).- Returns:
- the Reference Of The Account Servicing Institution from component 9
-
getComponent10
public java.lang.String getComponent10()
Gets the component 10 (Supplementary Details).- Returns:
- the component 10
-
getSupplementaryDetails
public java.lang.String getSupplementaryDetails()
Gets the Supplementary Details (component 10).- Returns:
- the Supplementary Details from component 10
-
setComponent1
public Field61 setComponent1(java.lang.String component1)
Set the component 1 (Value Date).- Parameters:
component1
- the Value Date to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field61 setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.- Parameters:
component1
- the Calendar with the Value Date content to set- Returns:
- the field object to enable build pattern
-
setValueDate
public Field61 setValueDate(java.lang.String component1)
Set the Value Date (component 1).- Parameters:
component1
- the Value Date to set- Returns:
- the field object to enable build pattern
-
setValueDate
public Field61 setValueDate(java.util.Calendar component1)
Set the Value Date (component 1) from a Calendar object.- Parameters:
component1
- Calendar with the Value Date content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent1(java.util.Calendar)
-
setDate
public Field61 setDate(java.lang.String component1)
Deprecated.use #setValueDate(String) instead
-
setDate
public Field61 setDate(java.util.Calendar component1)
Deprecated.use #setComponent1(java.util.Calendar) instead
-
setComponent2
public Field61 setComponent2(java.lang.String component2)
Set the component 2 (Entry Date).- Parameters:
component2
- the Entry Date to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field61 setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.- Parameters:
component2
- the Calendar with the Entry Date content to set- Returns:
- the field object to enable build pattern
-
setEntryDate
public Field61 setEntryDate(java.lang.String component2)
Set the Entry Date (component 2).- Parameters:
component2
- the Entry Date to set- Returns:
- the field object to enable build pattern
-
setEntryDate
public Field61 setEntryDate(java.util.Calendar component2)
Set the Entry Date (component 2) from a Calendar object.- Parameters:
component2
- Calendar with the Entry Date content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(java.util.Calendar)
-
setComponent3
public Field61 setComponent3(java.lang.String component3)
Set the component 3 (Debit/Credit Mark).- Parameters:
component3
- the Debit/Credit Mark to set- Returns:
- the field object to enable build pattern
-
setDebitCreditMark
public Field61 setDebitCreditMark(java.lang.String component3)
Set the Debit/Credit Mark (component 3).- Parameters:
component3
- the Debit/Credit Mark to set- Returns:
- the field object to enable build pattern
-
setDCMark
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field61 setDCMark(java.lang.String component3)
Deprecated.use #setDebitCreditMark(String) instead
-
setComponent4
public Field61 setComponent4(java.lang.String component4)
Set the component 4 (Funds Code).- Parameters:
component4
- the Funds Code to set- Returns:
- the field object to enable build pattern
-
setFundsCode
public Field61 setFundsCode(java.lang.String component4)
Set the Funds Code (component 4).- Parameters:
component4
- the Funds Code to set- Returns:
- the field object to enable build pattern
-
setComponent5
public Field61 setComponent5(java.lang.String component5)
Set the component 5 (Amount).- Parameters:
component5
- the Amount to set- Returns:
- the field object to enable build pattern
-
setComponent5
public Field61 setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.
Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.- Example: 1234.00 -> 1234,
- Example: 1234 -> 1234,
- Example: 1234.56 -> 1234,56
- Parameters:
component5
- the BigDecimal with the Amount content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
-
setComponent5
public Field61 setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)- Parameters:
component5
- the Number with the Amount content to set- Returns:
- the field object to enable build pattern
- See Also:
setAmount(java.math.BigDecimal)
-
setAmount
public Field61 setAmount(java.lang.String component5)
Set the Amount (component 5).- Parameters:
component5
- the Amount to set- Returns:
- the field object to enable build pattern
-
setAmount
public Field61 setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.- Parameters:
component5
- BigDecimal with the Amount content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent5(java.math.BigDecimal)
-
setAmount
public Field61 setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component5
- the Number with the Amount content to set- Returns:
- the field object to enable build pattern
- See Also:
setAmount(java.math.BigDecimal)
-
setComponent6
public Field61 setComponent6(java.lang.String component6)
Set the component 6 (Transaction Type).- Parameters:
component6
- the Transaction Type to set- Returns:
- the field object to enable build pattern
-
setTransactionType
public Field61 setTransactionType(java.lang.String component6)
Set the Transaction Type (component 6).- Parameters:
component6
- the Transaction Type to set- Returns:
- the field object to enable build pattern
-
setComponent7
public Field61 setComponent7(java.lang.String component7)
Set the component 7 (Identification Code).- Parameters:
component7
- the Identification Code to set- Returns:
- the field object to enable build pattern
-
setIdentificationCode
public Field61 setIdentificationCode(java.lang.String component7)
Set the Identification Code (component 7).- Parameters:
component7
- the Identification Code to set- Returns:
- the field object to enable build pattern
-
setComponent8
public Field61 setComponent8(java.lang.String component8)
Set the component 8 (Reference For The Account Owner).- Parameters:
component8
- the Reference For The Account Owner to set- Returns:
- the field object to enable build pattern
-
setReferenceForTheAccountOwner
public Field61 setReferenceForTheAccountOwner(java.lang.String component8)
Set the Reference For The Account Owner (component 8).- Parameters:
component8
- the Reference For The Account Owner to set- Returns:
- the field object to enable build pattern
-
setComponent9
public Field61 setComponent9(java.lang.String component9)
Set the component 9 (Reference Of The Account Servicing Institution).- Parameters:
component9
- the Reference Of The Account Servicing Institution to set- Returns:
- the field object to enable build pattern
-
setReferenceOfTheAccountServicingInstitution
public Field61 setReferenceOfTheAccountServicingInstitution(java.lang.String component9)
Set the Reference Of The Account Servicing Institution (component 9).- Parameters:
component9
- the Reference Of The Account Servicing Institution to set- Returns:
- the field object to enable build pattern
-
setComponent10
public Field61 setComponent10(java.lang.String component10)
Set the component 10 (Supplementary Details).- Parameters:
component10
- the Supplementary Details to set- Returns:
- the field object to enable build pattern
-
setSupplementaryDetails
public Field61 setSupplementaryDetails(java.lang.String component10)
Set the Supplementary Details (component 10).- Parameters:
component10
- the Supplementary Details to set- Returns:
- the field object to enable build pattern
-
amounts
public java.util.List<java.math.BigDecimal> amounts()
Returns the list of all NON-NULL amounts as BigDecimal- Returns:
- the list of NON-NULL amounts as BigDecimal values
- See Also:
AmountResolver.amounts(Field)
-
amount
public java.math.BigDecimal amount()
Returns the first amounts as BigDecimal- Specified by:
amount
in interfaceAmountContainer
- Returns:
- the first amount as BigDecimal value. Can be null
- See Also:
AmountResolver.amount(Field)
-
dates
public java.util.List<java.util.Calendar> dates()
Returns all components that can be converted to a Calendar- Specified by:
dates
in interfaceDateContainer
- Returns:
- the list of converted components (a Calendar object or null)
- Since:
- 9.2.7
-
date
public java.util.Calendar date()
Returns the first component that can be converted to a Calendar- Returns:
- the converted components (a Calendar object or null)
- Since:
- 9.2.7
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field61 get(SwiftTagListBlock block)
Gets 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 Field61 get(SwiftMessage msg)
Gets the first instance of Field61 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 java.util.List<Field61> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field61 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 java.util.List<Field61> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field61 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
-
getLine
public java.lang.String getLine(int line)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int)
-
getLine
public java.lang.String getLine(int line, int offset)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting lines- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int, int)
-
getLines
public java.util.List<java.lang.String> getLines()
Returns the field value split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Returns:
- lines content or empty list if field's value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLines()
-
getLines
public java.util.List<java.lang.String> getLines(int offset)
Returns the field value starting at the offset component, split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Parameters:
offset
- an optional component number used as offset when counting lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLines(int)
-
getLinesBetween
public java.util.List<java.lang.String> getLinesBetween(int start, int end)
Returns a specific subset of lines from the field's value, given a range.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than start- Returns:
- found lines or empty list if value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int, int )
-
getLinesBetween
public java.util.List<java.lang.String> getLinesBetween(int start, int end, int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startoffset
- an optional component number used as offset when counting lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int start, int end, int offset)
-
fromJson
public static Field61 fromJson(java.lang.String json)
This method deserializes the JSON data into a Field61 object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
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.
MT=940, 942
<DATE2>[<DATE1>]2a[1a]<NUMBER>15<SUB-6><VAR-SEQU-1>[’CRLF’<ERI-F61>]MT=other, i.e. : 608, 950, 970, 972, n92, n95, n96
<DATE2>[<DATE1>]2a[1a]<NUMBER>15<SUB-6><VAR-SEQU-1>[’CRLF’34x](**)
-
-