Class MT097

  • All Implemented Interfaces:
    JsonSerializable, java.io.Serializable

    @Generated
    public class MT097
    extends AbstractMT
    implements java.io.Serializable
    MT 097 - FINCopy Message Authorisation/Refusal Notification.

    SWIFT MT097 (ISO 15022) message structure:

    • Field 103 (M)
    • Field 109 (M)
    • Field 451 (M)
    • Field 432 (O)
    • Field 114 (O)
    • Field 115 (O)
    • Field 165 (O)
    • Field 433 (O)
    • Field 422 (O)
    • Field 425 (O)

    This source code is specific to release SRU 2022

    For additional resources check https://www.prowidesoftware.com/resources

    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 for MT name, this is part of the classname, after MT.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MT097

        public MT097​(SwiftMessage m)
        Creates an MT097 initialized with the parameter SwiftMessage.
        Parameters:
        m - swift message with the MT097 content
      • MT097

        public MT097​(MtSwiftMessage m)
        Creates an MT097 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT097 content, the parameter can not be null
        See Also:
        MT097(String)
      • MT097

        public MT097()
        Creates and initializes a new MT097 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
        Since:
        7.6
      • MT097

        public MT097​(java.lang.String sender,
                     java.lang.String receiver)
        Creates and initializes a new MT097 input message from sender to receiver. All mandatory header attributes are completed with default values. In particular the sender and receiver addresses will be filled with proper default LT identifier and branch codes if not provided,
        Parameters:
        sender - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
        receiver - the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
        Since:
        7.7
      • MT097

        public MT097​(java.lang.String fin)
        Creates a new MT097 by parsing a String with the message content in its swift FIN format. If the fin parameter is null or the message cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
        Parameters:
        fin - a string with the MT message in its FIN swift format
        Since:
        7.7
      • MT097

        public MT097​(java.io.InputStream stream)
              throws java.io.IOException
        Creates a new MT097 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the message content is null or cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the stream contains multiple messages, only the first one will be parsed.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • MT097

        public MT097​(java.io.File file)
              throws java.io.IOException
        Creates a new MT097 by parsing a file with the message content in its swift FIN format. If the file content is null or cannot be parsed as a message, the internal message object will be initialized (blocks will be created) but empty. If the file contains multiple messages, only the first one will be parsed.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
    • Method Detail

      • parse

        public static MT097 parse​(MtSwiftMessage m)
        Creates an MT097 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT097 content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT097(String)
      • parse

        public static MT097 parse​(java.lang.String fin)
        Creates a new MT097 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT097 will have its internal message object initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
        Parameters:
        fin - a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
        Returns:
        a new instance of MT097 or null if fin is null
        Since:
        7.7
      • parse

        public static MT097 parse​(java.io.InputStream stream)
                           throws java.io.IOException
        Creates a new MT097 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the stream contains multiple messages, only the first one will be parsed.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Returns:
        a new instance of MT097 or null if stream is null or the message cannot be parsed
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • parse

        public static MT097 parse​(java.io.File file)
                           throws java.io.IOException
        Creates a new MT097 by parsing a file with the message content in its swift FIN format. If the file contains multiple messages, only the first one will be parsed.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Returns:
        a new instance of MT097 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
      • getMessageType

        public java.lang.String getMessageType()
        Returns this MT number.
        Specified by:
        getMessageType in class AbstractMT
        Returns:
        the message type number of this MT
        Since:
        6.4
      • append

        public MT097 append​(SwiftTagListBlock block)
        Add all tags from block to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        block - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT097 append​(Tag... tags)
        Add all tags to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        tags - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT097 append​(Field... fields)
        Add all the fields to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        fields - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • fromJson

        public static MT097 fromJson​(java.lang.String json)
        Creates an MT097 messages from its JSON representation.

        For generic conversion of JSON into the corresponding MT instance see AbstractMT.fromJson(String)

        Parameters:
        json - a JSON representation of an MT097 message
        Returns:
        a new instance of MT097
        Since:
        7.10.3
      • getField103

        public Field103 getField103()
        Iterates through block4 fields and return the first one whose name matches 103, or null if none is found. The first occurrence of field 103 at MT097 is expected to be the only one.
        Returns:
        a Field103 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField109

        public Field109 getField109()
        Iterates through block4 fields and return the first one whose name matches 109, or null if none is found. The first occurrence of field 109 at MT097 is expected to be the only one.
        Returns:
        a Field109 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField451

        public Field451 getField451()
        Iterates through block4 fields and return the first one whose name matches 451, or null if none is found. The first occurrence of field 451 at MT097 is expected to be the only one.
        Returns:
        a Field451 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField432

        public Field432 getField432()
        Iterates through block4 fields and return the first one whose name matches 432, or null if none is found. The first occurrence of field 432 at MT097 is expected to be the only one.
        Returns:
        a Field432 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField114

        public Field114 getField114()
        Iterates through block4 fields and return the first one whose name matches 114, or null if none is found. The first occurrence of field 114 at MT097 is expected to be the only one.
        Returns:
        a Field114 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField115

        public Field115 getField115()
        Iterates through block4 fields and return the first one whose name matches 115, or null if none is found. The first occurrence of field 115 at MT097 is expected to be the only one.
        Returns:
        a Field115 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField165

        public Field165 getField165()
        Iterates through block4 fields and return the first one whose name matches 165, or null if none is found. The first occurrence of field 165 at MT097 is expected to be the only one.
        Returns:
        a Field165 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField433

        public Field433 getField433()
        Iterates through block4 fields and return the first one whose name matches 433, or null if none is found. The first occurrence of field 433 at MT097 is expected to be the only one.
        Returns:
        a Field433 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField422

        public Field422 getField422()
        Iterates through block4 fields and return the first one whose name matches 422, or null if none is found. The first occurrence of field 422 at MT097 is expected to be the only one.
        Returns:
        a Field422 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField425

        public Field425 getField425()
        Iterates through block4 fields and return the first one whose name matches 425, or null if none is found. The first occurrence of field 425 at MT097 is expected to be the only one.
        Returns:
        a Field425 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)