Package com.prowidesoftware.swift.model.field

Class Field331

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

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

    Subfields (components) Data types

    1. Component 1: SessionNumber: Long
    2. Component 2: DateSessionOpened: Calendar
    3. Component 3: TimeSessionOpened: Calendar
    4. Component 4: DateSessionClosed: Calendar
    5. Component 5: TimeSessionClosed: Calendar
    6. Component 6: ReasonForClosure: Long
    7. Component 7: QuantityOfMessagesSent: Long
    8. Component 8: QuantityOfMessagesReceived: Long
    9. Component 9: FirstInputSequenceNumber: Long
    10. Component 10: LastInputSequenceNumber: Long
    11. Component 11: FirstOutputSequenceNumber: Long
    12. Component 12: LastOutputSequenceNumber: Long

    Structure definition

    • validation pattern: 4!n<DATE2><HHMM><DATE2><HHMM>3!n6!n6!n6!n6!n6!n6!n
    • parser pattern: 4!N<DATE2><HHMM><DATE2><HHMM>3!N6!N6!N6!N6!N6!N6!N
    • components pattern: NEHEHNNNNNNN

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

      • F_331

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

      • SESSION_NUMBER

        public static final java.lang.Integer SESSION_NUMBER
        Component number for the Session Number subfield.

      • DATE_SESSION_OPENED

        public static final java.lang.Integer DATE_SESSION_OPENED
        Component number for the Date Session Opened subfield.

      • TIME_SESSION_OPENED

        public static final java.lang.Integer TIME_SESSION_OPENED
        Component number for the Time Session Opened subfield.

      • DATE_SESSION_CLOSED

        public static final java.lang.Integer DATE_SESSION_CLOSED
        Component number for the Date Session Closed subfield.

      • TIME_SESSION_CLOSED

        public static final java.lang.Integer TIME_SESSION_CLOSED
        Component number for the Time Session Closed subfield.

      • REASON_FOR_CLOSURE

        public static final java.lang.Integer REASON_FOR_CLOSURE
        Component number for the Reason For Closure subfield.

      • QUANTITY_OF_MESSAGES_SENT

        public static final java.lang.Integer QUANTITY_OF_MESSAGES_SENT
        Component number for the Quantity Of Messages Sent subfield.

      • QUANTITY_OF_MESSAGES_RECEIVED

        public static final java.lang.Integer QUANTITY_OF_MESSAGES_RECEIVED
        Component number for the Quantity Of Messages Received subfield.

      • FIRST_INPUT_SEQUENCE_NUMBER

        public static final java.lang.Integer FIRST_INPUT_SEQUENCE_NUMBER
        Component number for the First Input Sequence Number subfield.

      • LAST_INPUT_SEQUENCE_NUMBER

        public static final java.lang.Integer LAST_INPUT_SEQUENCE_NUMBER
        Component number for the Last Input Sequence Number subfield.

      • FIRST_OUTPUT_SEQUENCE_NUMBER

        public static final java.lang.Integer FIRST_OUTPUT_SEQUENCE_NUMBER
        Component number for the First Output Sequence Number subfield.

      • LAST_OUTPUT_SEQUENCE_NUMBER

        public static final java.lang.Integer LAST_OUTPUT_SEQUENCE_NUMBER
        Component number for the Last Output Sequence Number subfield.

    • Constructor Detail

      • Field331

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

      • Field331

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

      • Field331

        public Field331​(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 Field331 newInstance​(Field331 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 (Session Number).
        Returns:
        the component 1

      • getComponent1AsLong

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

      • getComponent1AsNumber

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

      • getSessionNumber

        public java.lang.String getSessionNumber()
        Gets the Session Number (component 1).
        Returns:
        the Session Number from component 1

      • getSessionNumberAsLong

        public java.lang.Long getSessionNumberAsLong()
        Get the Session Number (component 1) as Long
        Returns:
        the Session Number from component 1 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getSessionNumberAsNumber

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

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (Date Session Opened).
        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

      • getDateSessionOpened

        public java.lang.String getDateSessionOpened()
        Gets the Date Session Opened (component 2).
        Returns:
        the Date Session Opened from component 2

      • getDateSessionOpenedAsCalendar

        public java.util.Calendar getDateSessionOpenedAsCalendar()
        Get the Date Session Opened (component 2) as Calendar
        Returns:
        the Date Session Opened from component 2 converted to Calendar or null if cannot be converted

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Time Session Opened).
        Returns:
        the component 3

      • getComponent3AsCalendar

        public java.util.Calendar getComponent3AsCalendar()
        Get the component 3 as Calendar
        Returns:
        the component 3 converted to Calendar or null if cannot be converted

      • getTimeSessionOpened

        public java.lang.String getTimeSessionOpened()
        Gets the Time Session Opened (component 3).
        Returns:
        the Time Session Opened from component 3

      • getTimeSessionOpenedAsCalendar

        public java.util.Calendar getTimeSessionOpenedAsCalendar()
        Get the Time Session Opened (component 3) as Calendar
        Returns:
        the Time Session Opened from component 3 converted to Calendar or null if cannot be converted

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (Date Session Closed).
        Returns:
        the component 4

      • getComponent4AsCalendar

        public java.util.Calendar getComponent4AsCalendar()
        Get the component 4 as Calendar
        Returns:
        the component 4 converted to Calendar or null if cannot be converted

      • getDateSessionClosed

        public java.lang.String getDateSessionClosed()
        Gets the Date Session Closed (component 4).
        Returns:
        the Date Session Closed from component 4

      • getDateSessionClosedAsCalendar

        public java.util.Calendar getDateSessionClosedAsCalendar()
        Get the Date Session Closed (component 4) as Calendar
        Returns:
        the Date Session Closed from component 4 converted to Calendar or null if cannot be converted

      • getComponent5

        public java.lang.String getComponent5()
        Gets the component 5 (Time Session Closed).
        Returns:
        the component 5

      • getComponent5AsCalendar

        public java.util.Calendar getComponent5AsCalendar()
        Get the component 5 as Calendar
        Returns:
        the component 5 converted to Calendar or null if cannot be converted

      • getTimeSessionClosed

        public java.lang.String getTimeSessionClosed()
        Gets the Time Session Closed (component 5).
        Returns:
        the Time Session Closed from component 5

      • getTimeSessionClosedAsCalendar

        public java.util.Calendar getTimeSessionClosedAsCalendar()
        Get the Time Session Closed (component 5) as Calendar
        Returns:
        the Time Session Closed from component 5 converted to Calendar or null if cannot be converted

      • getComponent6

        public java.lang.String getComponent6()
        Gets the component 6 (Reason For Closure).
        Returns:
        the component 6

      • getComponent6AsLong

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

      • getComponent6AsNumber

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

      • getReasonForClosure

        public java.lang.String getReasonForClosure()
        Gets the Reason For Closure (component 6).
        Returns:
        the Reason For Closure from component 6

      • getReasonForClosureAsLong

        public java.lang.Long getReasonForClosureAsLong()
        Get the Reason For Closure (component 6) as Long
        Returns:
        the Reason For Closure from component 6 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getReasonForClosureAsNumber

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

      • getComponent7

        public java.lang.String getComponent7()
        Gets the component 7 (Quantity Of Messages Sent).
        Returns:
        the component 7

      • getComponent7AsLong

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

      • getComponent7AsNumber

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

      • getQuantityOfMessagesSent

        public java.lang.String getQuantityOfMessagesSent()
        Gets the Quantity Of Messages Sent (component 7).
        Returns:
        the Quantity Of Messages Sent from component 7

      • getQuantityOfMessagesSentAsLong

        public java.lang.Long getQuantityOfMessagesSentAsLong()
        Get the Quantity Of Messages Sent (component 7) as Long
        Returns:
        the Quantity Of Messages Sent from component 7 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getQuantityOfMessagesSentAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getQuantityOfMessagesSentAsNumber()
        Deprecated.
        Get the Quantity Of Messages Sent (component 7) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent7AsLong() to get the proper value.
        Returns:
        the component 7 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getQuantityOfMessagesSentAsLong()

      • getComponent8

        public java.lang.String getComponent8()
        Gets the component 8 (Quantity Of Messages Received).
        Returns:
        the component 8

      • getComponent8AsLong

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

      • getComponent8AsNumber

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

      • getQuantityOfMessagesReceived

        public java.lang.String getQuantityOfMessagesReceived()
        Gets the Quantity Of Messages Received (component 8).
        Returns:
        the Quantity Of Messages Received from component 8

      • getQuantityOfMessagesReceivedAsLong

        public java.lang.Long getQuantityOfMessagesReceivedAsLong()
        Get the Quantity Of Messages Received (component 8) as Long
        Returns:
        the Quantity Of Messages Received from component 8 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getQuantityOfMessagesReceivedAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getQuantityOfMessagesReceivedAsNumber()
        Deprecated.
        Get the Quantity Of Messages Received (component 8) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent8AsLong() to get the proper value.
        Returns:
        the component 8 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getQuantityOfMessagesReceivedAsLong()

      • getComponent9

        public java.lang.String getComponent9()
        Gets the component 9 (First Input Sequence Number).
        Returns:
        the component 9

      • getComponent9AsLong

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

      • getComponent9AsNumber

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

      • getFirstInputSequenceNumber

        public java.lang.String getFirstInputSequenceNumber()
        Gets the First Input Sequence Number (component 9).
        Returns:
        the First Input Sequence Number from component 9

      • getFirstInputSequenceNumberAsLong

        public java.lang.Long getFirstInputSequenceNumberAsLong()
        Get the First Input Sequence Number (component 9) as Long
        Returns:
        the First Input Sequence Number from component 9 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getFirstInputSequenceNumberAsNumber

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

      • getComponent10

        public java.lang.String getComponent10()
        Gets the component 10 (Last Input Sequence Number).
        Returns:
        the component 10

      • getComponent10AsLong

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

      • getComponent10AsNumber

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

      • getLastInputSequenceNumber

        public java.lang.String getLastInputSequenceNumber()
        Gets the Last Input Sequence Number (component 10).
        Returns:
        the Last Input Sequence Number from component 10

      • getLastInputSequenceNumberAsLong

        public java.lang.Long getLastInputSequenceNumberAsLong()
        Get the Last Input Sequence Number (component 10) as Long
        Returns:
        the Last Input Sequence Number from component 10 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getLastInputSequenceNumberAsNumber

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

      • getComponent11

        public java.lang.String getComponent11()
        Gets the component 11 (First Output Sequence Number).
        Returns:
        the component 11

      • getComponent11AsLong

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

      • getComponent11AsNumber

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

      • getFirstOutputSequenceNumber

        public java.lang.String getFirstOutputSequenceNumber()
        Gets the First Output Sequence Number (component 11).
        Returns:
        the First Output Sequence Number from component 11

      • getFirstOutputSequenceNumberAsLong

        public java.lang.Long getFirstOutputSequenceNumberAsLong()
        Get the First Output Sequence Number (component 11) as Long
        Returns:
        the First Output Sequence Number from component 11 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getFirstOutputSequenceNumberAsNumber

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

      • getComponent12

        public java.lang.String getComponent12()
        Gets the component 12 (Last Output Sequence Number).
        Returns:
        the component 12

      • getComponent12AsLong

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

      • getComponent12AsNumber

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

      • getLastOutputSequenceNumber

        public java.lang.String getLastOutputSequenceNumber()
        Gets the Last Output Sequence Number (component 12).
        Returns:
        the Last Output Sequence Number from component 12

      • getLastOutputSequenceNumberAsLong

        public java.lang.Long getLastOutputSequenceNumberAsLong()
        Get the Last Output Sequence Number (component 12) as Long
        Returns:
        the Last Output Sequence Number from component 12 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getLastOutputSequenceNumberAsNumber

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

      • setComponent1

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

      • setComponent1

        public Field331 setComponent1​(java.lang.Long component1)
        Set the component1 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 setComponent1(String) method.
        Parameters:
        component1 - the Long with the Session Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent1(String)

      • setComponent1

        public Field331 setComponent1​(java.lang.Number component1)
        Alternative method setter for field's Session Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component1 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setSessionNumber(java.lang.Long)

      • setSessionNumber

        public Field331 setSessionNumber​(java.lang.String component1)
        Set the Session Number (component 1).
        Parameters:
        component1 - the Session Number to set
        Returns:
        the field object to enable build pattern

      • setSessionNumber

        public Field331 setSessionNumber​(java.lang.Long component1)
        Set the Session Number (component 1) from a Long object.
        Parameters:
        component1 - Long with the Session Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent1(java.lang.Long)

      • setSessionNumber

        public Field331 setSessionNumber​(java.lang.Number component1)
        Alternative method setter for field's Session Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component1 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setSessionNumber(java.lang.Long)

      • setComponent2

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

      • setComponent2

        public Field331 setComponent2​(java.util.Calendar component2)
        Set the component2 from a Calendar object.
        Parameters:
        component2 - the Calendar with the Date Session Opened content to set
        Returns:
        the field object to enable build pattern

      • setDateSessionOpened

        public Field331 setDateSessionOpened​(java.lang.String component2)
        Set the Date Session Opened (component 2).
        Parameters:
        component2 - the Date Session Opened to set
        Returns:
        the field object to enable build pattern

      • setDateSessionOpened

        public Field331 setDateSessionOpened​(java.util.Calendar component2)
        Set the Date Session Opened (component 2) from a Calendar object.
        Parameters:
        component2 - Calendar with the Date Session Opened content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent2(java.util.Calendar)

      • setComponent3

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

      • setComponent3

        public Field331 setComponent3​(java.util.Calendar component3)
        Set the component3 from a Calendar object.
        Parameters:
        component3 - the Calendar with the Time Session Opened content to set
        Returns:
        the field object to enable build pattern

      • setTimeSessionOpened

        public Field331 setTimeSessionOpened​(java.lang.String component3)
        Set the Time Session Opened (component 3).
        Parameters:
        component3 - the Time Session Opened to set
        Returns:
        the field object to enable build pattern

      • setTimeSessionOpened

        public Field331 setTimeSessionOpened​(java.util.Calendar component3)
        Set the Time Session Opened (component 3) from a Calendar object.
        Parameters:
        component3 - Calendar with the Time Session Opened content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent3(java.util.Calendar)

      • setComponent4

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

      • setComponent4

        public Field331 setComponent4​(java.util.Calendar component4)
        Set the component4 from a Calendar object.
        Parameters:
        component4 - the Calendar with the Date Session Closed content to set
        Returns:
        the field object to enable build pattern

      • setDateSessionClosed

        public Field331 setDateSessionClosed​(java.lang.String component4)
        Set the Date Session Closed (component 4).
        Parameters:
        component4 - the Date Session Closed to set
        Returns:
        the field object to enable build pattern

      • setDateSessionClosed

        public Field331 setDateSessionClosed​(java.util.Calendar component4)
        Set the Date Session Closed (component 4) from a Calendar object.
        Parameters:
        component4 - Calendar with the Date Session Closed content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent4(java.util.Calendar)

      • setComponent5

        public Field331 setComponent5​(java.lang.String component5)
        Set the component 5 (Time Session Closed).
        Parameters:
        component5 - the Time Session Closed to set
        Returns:
        the field object to enable build pattern

      • setComponent5

        public Field331 setComponent5​(java.util.Calendar component5)
        Set the component5 from a Calendar object.
        Parameters:
        component5 - the Calendar with the Time Session Closed content to set
        Returns:
        the field object to enable build pattern

      • setTimeSessionClosed

        public Field331 setTimeSessionClosed​(java.lang.String component5)
        Set the Time Session Closed (component 5).
        Parameters:
        component5 - the Time Session Closed to set
        Returns:
        the field object to enable build pattern

      • setTimeSessionClosed

        public Field331 setTimeSessionClosed​(java.util.Calendar component5)
        Set the Time Session Closed (component 5) from a Calendar object.
        Parameters:
        component5 - Calendar with the Time Session Closed content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent5(java.util.Calendar)

      • setComponent6

        public Field331 setComponent6​(java.lang.String component6)
        Set the component 6 (Reason For Closure).
        Parameters:
        component6 - the Reason For Closure to set
        Returns:
        the field object to enable build pattern

      • setComponent6

        public Field331 setComponent6​(java.lang.Long component6)
        Set the component6 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 setComponent6(String) method.
        Parameters:
        component6 - the Long with the Reason For Closure content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent6(String)

      • setComponent6

        public Field331 setComponent6​(java.lang.Number component6)
        Alternative method setter for field's Reason For Closure (component 6) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component6 - the Number with the Reason For Closure content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setReasonForClosure(java.lang.Long)

      • setReasonForClosure

        public Field331 setReasonForClosure​(java.lang.String component6)
        Set the Reason For Closure (component 6).
        Parameters:
        component6 - the Reason For Closure to set
        Returns:
        the field object to enable build pattern

      • setReasonForClosure

        public Field331 setReasonForClosure​(java.lang.Long component6)
        Set the Reason For Closure (component 6) from a Long object.
        Parameters:
        component6 - Long with the Reason For Closure content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent6(java.lang.Long)

      • setReasonForClosure

        public Field331 setReasonForClosure​(java.lang.Number component6)
        Alternative method setter for field's Reason For Closure (component 6) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component6 - the Number with the Reason For Closure content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setReasonForClosure(java.lang.Long)

      • setComponent7

        public Field331 setComponent7​(java.lang.String component7)
        Set the component 7 (Quantity Of Messages Sent).
        Parameters:
        component7 - the Quantity Of Messages Sent to set
        Returns:
        the field object to enable build pattern

      • setComponent7

        public Field331 setComponent7​(java.lang.Long component7)
        Set the component7 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 setComponent7(String) method.
        Parameters:
        component7 - the Long with the Quantity Of Messages Sent content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent7(String)

      • setComponent7

        public Field331 setComponent7​(java.lang.Number component7)
        Alternative method setter for field's Quantity Of Messages Sent (component 7) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component7 - the Number with the Quantity Of Messages Sent content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantityOfMessagesSent(java.lang.Long)

      • setQuantityOfMessagesSent

        public Field331 setQuantityOfMessagesSent​(java.lang.String component7)
        Set the Quantity Of Messages Sent (component 7).
        Parameters:
        component7 - the Quantity Of Messages Sent to set
        Returns:
        the field object to enable build pattern

      • setQuantityOfMessagesSent

        public Field331 setQuantityOfMessagesSent​(java.lang.Long component7)
        Set the Quantity Of Messages Sent (component 7) from a Long object.
        Parameters:
        component7 - Long with the Quantity Of Messages Sent content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent7(java.lang.Long)

      • setQuantityOfMessagesSent

        public Field331 setQuantityOfMessagesSent​(java.lang.Number component7)
        Alternative method setter for field's Quantity Of Messages Sent (component 7) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component7 - the Number with the Quantity Of Messages Sent content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantityOfMessagesSent(java.lang.Long)

      • setComponent8

        public Field331 setComponent8​(java.lang.String component8)
        Set the component 8 (Quantity Of Messages Received).
        Parameters:
        component8 - the Quantity Of Messages Received to set
        Returns:
        the field object to enable build pattern

      • setComponent8

        public Field331 setComponent8​(java.lang.Long component8)
        Set the component8 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 setComponent8(String) method.
        Parameters:
        component8 - the Long with the Quantity Of Messages Received content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent8(String)

      • setComponent8

        public Field331 setComponent8​(java.lang.Number component8)
        Alternative method setter for field's Quantity Of Messages Received (component 8) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component8 - the Number with the Quantity Of Messages Received content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantityOfMessagesReceived(java.lang.Long)

      • setQuantityOfMessagesReceived

        public Field331 setQuantityOfMessagesReceived​(java.lang.String component8)
        Set the Quantity Of Messages Received (component 8).
        Parameters:
        component8 - the Quantity Of Messages Received to set
        Returns:
        the field object to enable build pattern

      • setQuantityOfMessagesReceived

        public Field331 setQuantityOfMessagesReceived​(java.lang.Long component8)
        Set the Quantity Of Messages Received (component 8) from a Long object.
        Parameters:
        component8 - Long with the Quantity Of Messages Received content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent8(java.lang.Long)

      • setQuantityOfMessagesReceived

        public Field331 setQuantityOfMessagesReceived​(java.lang.Number component8)
        Alternative method setter for field's Quantity Of Messages Received (component 8) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component8 - the Number with the Quantity Of Messages Received content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantityOfMessagesReceived(java.lang.Long)

      • setComponent9

        public Field331 setComponent9​(java.lang.String component9)
        Set the component 9 (First Input Sequence Number).
        Parameters:
        component9 - the First Input Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setComponent9

        public Field331 setComponent9​(java.lang.Long component9)
        Set the component9 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 setComponent9(String) method.
        Parameters:
        component9 - the Long with the First Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent9(String)

      • setComponent9

        public Field331 setComponent9​(java.lang.Number component9)
        Alternative method setter for field's First Input Sequence Number (component 9) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component9 - the Number with the First Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setFirstInputSequenceNumber(java.lang.Long)

      • setFirstInputSequenceNumber

        public Field331 setFirstInputSequenceNumber​(java.lang.String component9)
        Set the First Input Sequence Number (component 9).
        Parameters:
        component9 - the First Input Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setFirstInputSequenceNumber

        public Field331 setFirstInputSequenceNumber​(java.lang.Long component9)
        Set the First Input Sequence Number (component 9) from a Long object.
        Parameters:
        component9 - Long with the First Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent9(java.lang.Long)

      • setFirstInputSequenceNumber

        public Field331 setFirstInputSequenceNumber​(java.lang.Number component9)
        Alternative method setter for field's First Input Sequence Number (component 9) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component9 - the Number with the First Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setFirstInputSequenceNumber(java.lang.Long)

      • setComponent10

        public Field331 setComponent10​(java.lang.String component10)
        Set the component 10 (Last Input Sequence Number).
        Parameters:
        component10 - the Last Input Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setComponent10

        public Field331 setComponent10​(java.lang.Long component10)
        Set the component10 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 setComponent10(String) method.
        Parameters:
        component10 - the Long with the Last Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent10(String)

      • setComponent10

        public Field331 setComponent10​(java.lang.Number component10)
        Alternative method setter for field's Last Input Sequence Number (component 10) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component10 - the Number with the Last Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLastInputSequenceNumber(java.lang.Long)

      • setLastInputSequenceNumber

        public Field331 setLastInputSequenceNumber​(java.lang.String component10)
        Set the Last Input Sequence Number (component 10).
        Parameters:
        component10 - the Last Input Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setLastInputSequenceNumber

        public Field331 setLastInputSequenceNumber​(java.lang.Long component10)
        Set the Last Input Sequence Number (component 10) from a Long object.
        Parameters:
        component10 - Long with the Last Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent10(java.lang.Long)

      • setLastInputSequenceNumber

        public Field331 setLastInputSequenceNumber​(java.lang.Number component10)
        Alternative method setter for field's Last Input Sequence Number (component 10) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component10 - the Number with the Last Input Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLastInputSequenceNumber(java.lang.Long)

      • setComponent11

        public Field331 setComponent11​(java.lang.String component11)
        Set the component 11 (First Output Sequence Number).
        Parameters:
        component11 - the First Output Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setComponent11

        public Field331 setComponent11​(java.lang.Long component11)
        Set the component11 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 setComponent11(String) method.
        Parameters:
        component11 - the Long with the First Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent11(String)

      • setComponent11

        public Field331 setComponent11​(java.lang.Number component11)
        Alternative method setter for field's First Output Sequence Number (component 11) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component11 - the Number with the First Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setFirstOutputSequenceNumber(java.lang.Long)

      • setFirstOutputSequenceNumber

        public Field331 setFirstOutputSequenceNumber​(java.lang.String component11)
        Set the First Output Sequence Number (component 11).
        Parameters:
        component11 - the First Output Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setFirstOutputSequenceNumber

        public Field331 setFirstOutputSequenceNumber​(java.lang.Long component11)
        Set the First Output Sequence Number (component 11) from a Long object.
        Parameters:
        component11 - Long with the First Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent11(java.lang.Long)

      • setFirstOutputSequenceNumber

        public Field331 setFirstOutputSequenceNumber​(java.lang.Number component11)
        Alternative method setter for field's First Output Sequence Number (component 11) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component11 - the Number with the First Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setFirstOutputSequenceNumber(java.lang.Long)

      • setComponent12

        public Field331 setComponent12​(java.lang.String component12)
        Set the component 12 (Last Output Sequence Number).
        Parameters:
        component12 - the Last Output Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setComponent12

        public Field331 setComponent12​(java.lang.Long component12)
        Set the component12 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 setComponent12(String) method.
        Parameters:
        component12 - the Long with the Last Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent12(String)

      • setComponent12

        public Field331 setComponent12​(java.lang.Number component12)
        Alternative method setter for field's Last Output Sequence Number (component 12) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component12 - the Number with the Last Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLastOutputSequenceNumber(java.lang.Long)

      • setLastOutputSequenceNumber

        public Field331 setLastOutputSequenceNumber​(java.lang.String component12)
        Set the Last Output Sequence Number (component 12).
        Parameters:
        component12 - the Last Output Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setLastOutputSequenceNumber

        public Field331 setLastOutputSequenceNumber​(java.lang.Long component12)
        Set the Last Output Sequence Number (component 12) from a Long object.
        Parameters:
        component12 - Long with the Last Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent12(java.lang.Long)

      • setLastOutputSequenceNumber

        public Field331 setLastOutputSequenceNumber​(java.lang.Number component12)
        Alternative method setter for field's Last Output Sequence Number (component 12) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component12 - the Number with the Last Output Sequence Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setLastOutputSequenceNumber(java.lang.Long)

      • dates

        public java.util.List<java.util.Calendar> dates()
        Returns all components that can be converted to a Calendar
        Specified by:
        dates in interface DateContainer
        Returns:
        the list of converted components (a Calendar object or null)

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

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

      • get

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