Package com.prowidesoftware.swift.model.field

Class Field95S

  • All Implemented Interfaces:
    JsonSerializable, GenericField, PatternContainer, java.io.Serializable
    @Generated
public class Field95S
extends OptionSPartyField
implements java.io.Serializable, GenericField
    SWIFT MT Field 95S.

    Model and parser for field 95S of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Qualifier: String
    2. Component 2: DataSourceScheme: String
    3. Component 3: TypeOfID: String
    4. Component 4: CountryCode: String
    5. Component 5: AlternateID: String

    Structure definition

    • validation pattern: :4!c/[8c]/4!c/<CC>/30x(***)
    • parser pattern: :S/[S]/S/S/S
    • components pattern: SSSKS

    This class complies with standard release SRU2023

    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 95S.
        See Also:
        Constant Field Values

      • F_95S

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

      • CONDITIONAL_QUALIFIER

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

    • Constructor Detail

      • Field95S

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

      • Field95S

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

      • Field95S

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

      • validatorPattern

        public final java.lang.String validatorPattern()
        Returns the field validator pattern.
        Specified by:
        validatorPattern in class OptionSPartyField

      • setComponent1

        public Field95S 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 Field95S 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 Field95S setComponent2​(java.lang.String component2)
        Set the component 2 (Data Source Scheme).
        Parameters:
        component2 - the Data Source Scheme to set
        Returns:
        the field object to enable build pattern

      • setDataSourceScheme

        public Field95S setDataSourceScheme​(java.lang.String component2)
        Set the Data Source Scheme (component 2).
        Parameters:
        component2 - the Data Source Scheme to set
        Returns:
        the field object to enable build pattern

      • setComponent3

        public Field95S setComponent3​(java.lang.String component3)
        Set the component 3 (Type Of ID).
        Parameters:
        component3 - the Type Of ID to set
        Returns:
        the field object to enable build pattern

      • setTypeOfID

        public Field95S setTypeOfID​(java.lang.String component3)
        Set the Type Of ID (component 3).
        Parameters:
        component3 - the Type Of ID to set
        Returns:
        the field object to enable build pattern

      • setComponent4

        public Field95S setComponent4​(java.lang.String component4)
        Set the component 4 (Country Code).
        Parameters:
        component4 - the Country Code to set
        Returns:
        the field object to enable build pattern

      • setCountryCode

        public Field95S setCountryCode​(java.lang.String component4)
        Set the Country Code (component 4).
        Parameters:
        component4 - the Country Code to set
        Returns:
        the field object to enable build pattern

      • setComponent5

        public Field95S setComponent5​(java.lang.String component5)
        Set the component 5 (Alternate ID).
        Parameters:
        component5 - the Alternate ID to set
        Returns:
        the field object to enable build pattern

      • setAlternateID

        public Field95S setAlternateID​(java.lang.String component5)
        Set the Alternate ID (component 5).
        Parameters:
        component5 - the Alternate ID to set
        Returns:
        the field object to enable build pattern

      • 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 OptionSPartyField
        Returns:
        the static value of Field95S.NAME

      • get

        public static Field95S 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 Field95S get​(SwiftMessage msg)
        Gets the first instance of Field95S 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<Field95S> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field95S 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<Field95S> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field95S 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 Field95S fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field95S 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)