Package com.prowidesoftware.swift.model.field

Class Field281

  • All Implemented Interfaces:
    JsonSerializable, PatternContainer, java.io.Serializable
    @Generated
public class Field281
extends Field
implements java.io.Serializable
    SWIFT MT Field 281.

    Model and parser for field 281 of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: OutputTime: Calendar
    2. Component 2: MOR: MOR
    3. Component 3: Accepted: Boolean
    4. Component 4: Error: String

    Structure definition

    • validation pattern: <HHMM><MOR>1!a[3!c]
    • parser pattern: <HHMM><MOR>cS
    • components pattern: HVLS

    This class complies with standard release SRU2024

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

      • F_281

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

      • OUTPUT_TIME

        public static final java.lang.Integer OUTPUT_TIME
        Component number for the Output Time subfield.

      • MOR

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

      • ACCEPTED

        public static final java.lang.Integer ACCEPTED
        Component number for the Accepted subfield.

      • ERROR

        public static final java.lang.Integer ERROR
        Component number for the Error subfield.

    • Constructor Detail

      • Field281

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

      • Field281

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

      • Field281

        public Field281​(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 Field281 newInstance​(Field281 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 (Output Time).
        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

      • getOutputTime

        public java.lang.String getOutputTime()
        Gets the Output Time (component 1).
        Returns:
        the Output Time from component 1

      • getOutputTimeAsCalendar

        public java.util.Calendar getOutputTimeAsCalendar()
        Get the Output Time (component 1) as Calendar
        Returns:
        the Output Time from component 1 converted to Calendar or null if cannot be converted

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (MOR).
        Returns:
        the component 2

      • getComponent2AsMOR

        public MOR getComponent2AsMOR()
        Get the component 2 as MOR
        Returns:
        the component 2 converted to MOR or null if cannot be converted

      • getMOR

        public java.lang.String getMOR()
        Gets the MOR (component 2).
        Returns:
        the MOR from component 2

      • getMORAsMOR

        public MOR getMORAsMOR()
        Get the MOR (component 2) as MOR
        Returns:
        the MOR from component 2 converted to MOR or null if cannot be converted

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Accepted).
        Returns:
        the component 3

      • getComponent3AsBoolean

        public java.lang.Boolean getComponent3AsBoolean()
        Get the component 3 as Boolean
        Returns:
        the component 3 converted to Boolean or null if cannot be converted

      • getAccepted

        public java.lang.String getAccepted()
        Gets the Accepted (component 3).
        Returns:
        the Accepted from component 3

      • getAcceptedAsBoolean

        public java.lang.Boolean getAcceptedAsBoolean()
        Get the Accepted (component 3) as Boolean
        Returns:
        the Accepted from component 3 converted to Boolean or null if cannot be converted

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (Error).
        Returns:
        the component 4

      • getError

        public java.lang.String getError()
        Gets the Error (component 4).
        Returns:
        the Error from component 4

      • setComponent1

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

      • setComponent1

        public Field281 setComponent1​(java.util.Calendar component1)
        Set the component1 from a Calendar object.
        Parameters:
        component1 - the Calendar with the Output Time content to set
        Returns:
        the field object to enable build pattern

      • setOutputTime

        public Field281 setOutputTime​(java.lang.String component1)
        Set the Output Time (component 1).
        Parameters:
        component1 - the Output Time to set
        Returns:
        the field object to enable build pattern

      • setOutputTime

        public Field281 setOutputTime​(java.util.Calendar component1)
        Set the Output Time (component 1) from a Calendar object.
        Parameters:
        component1 - Calendar with the Output Time content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent1(java.util.Calendar)

      • setComponent2

        public Field281 setComponent2​(java.lang.String component2)
        Set the component 2 (MOR).
        Parameters:
        component2 - the MOR to set
        Returns:
        the field object to enable build pattern

      • setComponent2

        public Field281 setComponent2​(MOR component2)
        Set the component2 from a MOR object.
        Parameters:
        component2 - the MOR with the MOR content to set
        Returns:
        the field object to enable build pattern

      • setMOR

        public Field281 setMOR​(java.lang.String component2)
        Set the MOR (component 2).
        Parameters:
        component2 - the MOR to set
        Returns:
        the field object to enable build pattern

      • setComponent3

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

      • setComponent3

        public Field281 setComponent3​(java.lang.Boolean component3)
        Set the component3 from a Boolean object.
        Parameters:
        component3 - the Boolean with the Accepted content to set
        Returns:
        the field object to enable build pattern

      • setAccepted

        public Field281 setAccepted​(java.lang.String component3)
        Set the Accepted (component 3).
        Parameters:
        component3 - the Accepted to set
        Returns:
        the field object to enable build pattern

      • setAccepted

        public Field281 setAccepted​(java.lang.Boolean component3)
        Set the Accepted (component 3) from a Boolean object.
        Parameters:
        component3 - Boolean with the Accepted content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent3(java.lang.Boolean)

      • setComponent4

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

      • setError

        public Field281 setError​(java.lang.String component4)
        Set the Error (component 4).
        Parameters:
        component4 - the Error to set
        Returns:
        the field object to enable build pattern

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

      • get

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