Package com.prowidesoftware.swift.model.field

Class Field94L

  • All Implemented Interfaces:
    JsonSerializable, GenericField, PatternContainer, java.io.Serializable
    @Generated
public class Field94L
extends Field
implements java.io.Serializable, GenericField
    SWIFT MT Field 94L.

    Model and parser for field 94L of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Qualifier: String
    2. Component 2: LegalEntityIdentifierCode: String
    3. Component 3: LegalEntityIdentifierNumber: Long

    Structure definition

    • validation pattern: :4!c//18!c2!n
    • parser pattern: :S//18!SS
    • components pattern: SSN

    This class complies with standard release SRU2022

    See Also:
    Serialized Form

    • 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 94L.
        See Also:
        Constant Field Values

      • F_94L

        public static final java.lang.String F_94L
        Same as NAME, intended to be clear when using static imports.
        See Also:
        Constant Field Values

      • QUALIFIER

        public static final java.lang.Integer QUALIFIER
        Component number for the Qualifier subfield.

      • LEGAL_ENTITY_IDENTIFIER_CODE

        public static final java.lang.Integer LEGAL_ENTITY_IDENTIFIER_CODE
        Component number for the Legal Entity Identifier Code subfield.

      • LEGAL_ENTITY_IDENTIFIER_NUMBER

        public static final java.lang.Integer LEGAL_ENTITY_IDENTIFIER_NUMBER
        Component number for the Legal Entity Identifier Number subfield.

      • CONDITIONAL_QUALIFIER

        public static final java.lang.Integer CONDITIONAL_QUALIFIER
        Component number for the conditional qualifier subfield.

      • LEGAL_ENTITY_IDENTIFIER

        public static final java.lang.Integer LEGAL_ENTITY_IDENTIFIER
        Component number for the Legal Entity Identifier IMPORTANT: this constant is kept for (future) compatibility, but getting component 2 will return only part of the Legal Entity Identifier (the Code).
        Since:
        9.2.7

    • Constructor Detail

      • Field94L

        public Field94L()
        Default constructor. Creates a new field setting all components to null.

      • Field94L

        public Field94L​(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

      • Field94L

        public Field94L​(Tag tag)
        Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(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 Field94L newInstance​(Field94L 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 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

      • 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.

        Specified by:
        parse in class Field
        Parameters:
        value - complete field value including separators and CRLF
        Since:
        7.8

      • getValue

        public java.lang.String getValue()
        Serializes the fields' components into the single string value (SWIFT format)
        Specified by:
        getValue in class Field
        Returns:
        SWIFT formatted value

      • 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 class Field
        Parameters:
        component - number of the component to display
        locale - 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

      • 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 interface PatternContainer
        Specified by:
        typesPattern in class Field
        Since:
        9.2.7

      • parserPattern

        public java.lang.String parserPattern()
        Returns the field parser pattern.
        Specified by:
        parserPattern in interface PatternContainer

      • validatorPattern

        public java.lang.String validatorPattern()
        Returns the field validator pattern
        Specified by:
        validatorPattern in class 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

      • 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

      • 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 class Field
        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 class Field
        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 class Field
        Since:
        9.3.12
        See Also:
        Field.getLabelMap()

      • getComponent1

        public java.lang.String getComponent1()
        Gets the component 1 (Qualifier).
        Returns:
        the component 1

      • getQualifier

        public java.lang.String getQualifier()
        Gets the Qualifier (component 1).
        Returns:
        the Qualifier from component 1

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (Legal Entity Identifier Code).
        Returns:
        the component 2

      • getLegalEntityIdentifierCode

        public java.lang.String getLegalEntityIdentifierCode()
        Gets the Legal Entity Identifier Code (component 2).
        Returns:
        the Legal Entity Identifier Code from component 2

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Legal Entity Identifier Number).
        Returns:
        the component 3

      • getComponent3AsLong

        public java.lang.Long getComponent3AsLong()
        Get the component 3 as Long
        Returns:
        the component 3 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getComponent3AsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent3AsNumber()
        Deprecated.
        Get the component 3 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.
        Returns:
        the component 3 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getComponent3AsLong()

      • getLegalEntityIdentifierNumber

        public java.lang.String getLegalEntityIdentifierNumber()
        Gets the Legal Entity Identifier Number (component 3).
        Returns:
        the Legal Entity Identifier Number from component 3

      • getLegalEntityIdentifierNumberAsLong

        public java.lang.Long getLegalEntityIdentifierNumberAsLong()
        Get the Legal Entity Identifier Number (component 3) as Long
        Returns:
        the Legal Entity Identifier Number from component 3 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getLegalEntityIdentifierNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getLegalEntityIdentifierNumberAsNumber()
        Deprecated.
        Get the Legal Entity Identifier Number (component 3) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.
        Returns:
        the component 3 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getLegalEntityIdentifierNumberAsLong()

      • setComponent1

        public Field94L setComponent1​(java.lang.String component1)
        Set the component 1 (Qualifier).
        Parameters:
        component1 - the Qualifier to set
        Returns:
        the field object to enable build pattern

      • setQualifier

        public Field94L setQualifier​(java.lang.String component1)
        Set the Qualifier (component 1).
        Parameters:
        component1 - the Qualifier to set
        Returns:
        the field object to enable build pattern

      • setComponent2

        public Field94L setComponent2​(java.lang.String component2)
        Set the component 2 (Legal Entity Identifier Code).
        Parameters:
        component2 - the Legal Entity Identifier Code to set
        Returns:
        the field object to enable build pattern

      • setLegalEntityIdentifierCode

        public Field94L setLegalEntityIdentifierCode​(java.lang.String component2)
        Set the Legal Entity Identifier Code (component 2).
        Parameters:
        component2 - the Legal Entity Identifier Code to set
        Returns:
        the field object to enable build pattern

      • setComponent3

        public Field94L setComponent3​(java.lang.String component3)
        Set the component 3 (Legal Entity Identifier Number).
        Parameters:
        component3 - the Legal Entity Identifier Number to set
        Returns:
        the field object to enable build pattern

      • setComponent3

        public Field94L setComponent3​(java.lang.Long component3)
        Set the component3 from a Long object.
        If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.
        Parameters:
        component3 - the Long with the Legal Entity Identifier Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(String)

      • setComponent3

        public Field94L setComponent3​(java.lang.Number component3)
        Alternative method setter for field's Legal Entity Identifier Number (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component3 - the Number with the Legal Entity Identifier Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLegalEntityIdentifierNumber(java.lang.Long)

      • setLegalEntityIdentifierNumber

        public Field94L setLegalEntityIdentifierNumber​(java.lang.String component3)
        Set the Legal Entity Identifier Number (component 3).
        Parameters:
        component3 - the Legal Entity Identifier Number to set
        Returns:
        the field object to enable build pattern

      • setLegalEntityIdentifierNumber

        public Field94L setLegalEntityIdentifierNumber​(java.lang.Long component3)
        Set the Legal Entity Identifier Number (component 3) from a Long object.
        Parameters:
        component3 - Long with the Legal Entity Identifier Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(java.lang.Long)

      • setLegalEntityIdentifierNumber

        public Field94L setLegalEntityIdentifierNumber​(java.lang.Number component3)
        Alternative method setter for field's Legal Entity Identifier Number (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component3 - the Number with the Legal Entity Identifier Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLegalEntityIdentifierNumber(java.lang.Long)

      • 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
        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
        Returns:
        true if DSS is present, false otherwise.
        See Also:
        getDSS()

      • getConditionalQualifier

        public java.lang.String getConditionalQualifier()
        Gets the component with the conditional (secondary) qualifier.
        Specified by:
        getConditionalQualifier in interface GenericField
        Returns:
        for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this field.

      • getName

        public java.lang.String getName()
        Returns the field's name composed by the field number and the letter option (if any).
        Specified by:
        getName in class Field
        Returns:
        the static value of Field94L.NAME

      • get

        public static Field94L 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 Field94L get​(SwiftMessage msg)
        Gets the first instance of Field94L 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<Field94L> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field94L 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<Field94L> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field94L 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

      • fromJson

        public static Field94L fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field94L 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)

      • getLegalEntityIdentifier

        public java.lang.String getLegalEntityIdentifier()
        Gets the Legal Entity Identifier (components 2 and 3) as a unit Note this method was created for (future) compatibility.
        Returns:
        the concatenated values of component 2 and 3
        Since:
        9.2.7

      • setLegalEntityIdentifier

        public Field94L setLegalEntityIdentifier​(java.lang.String legalEntityIdentifier)
        Sets the Legal Entity Identifier (components 2 and 3) as a unit Note this method was created for (future) compatibility.
        Parameters:
        legalEntityIdentifier - the new expected value for components 2 and 3 concatenated
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7