Class MT942

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

    @Generated
    public class MT942
    extends AbstractMT
    implements java.io.Serializable
    MT 942 - Interim Transaction Report.

    SWIFT MT942 (ISO 15022) message structure:

    • Field 20 (M)
    • Field 21 (O)
    • Field 25 P,NONE (M)
    • Field 28 C (M)
    • Field 34 F (M) (repetitive)
    • Field 13 D (M)
    • Sequence _A (O) (repetitive)
      • Field 61 (O)
      • Field 86 (O)
    • Field 90 D (O)
    • Field 90 C (O)
    • Field 86 (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

      • MT942

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

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

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

        public MT942​(java.lang.String sender,
                     java.lang.String receiver)
        Creates and initializes a new MT942 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
      • MT942

        public MT942​(java.lang.String fin)
        Creates a new MT942 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
      • MT942

        public MT942​(java.io.InputStream stream)
              throws java.io.IOException
        Creates a new MT942 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
      • MT942

        public MT942​(java.io.File file)
              throws java.io.IOException
        Creates a new MT942 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 MT942 parse​(MtSwiftMessage m)
        Creates an MT942 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT942 content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT942(String)
      • parse

        public static MT942 parse​(java.lang.String fin)
        Creates a new MT942 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT942 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 MT942 or null if fin is null
        Since:
        7.7
      • parse

        public static MT942 parse​(java.io.InputStream stream)
                           throws java.io.IOException
        Creates a new MT942 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 MT942 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 MT942 parse​(java.io.File file)
                           throws java.io.IOException
        Creates a new MT942 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 MT942 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 MT942 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 MT942 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 MT942 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 MT942 fromJson​(java.lang.String json)
        Creates an MT942 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 MT942 message
        Returns:
        a new instance of MT942
        Since:
        7.10.3
      • getField20

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

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

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

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

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

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

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

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

        public java.util.List<Field34F> getField34F()
        Iterates through block4 fields and return all occurrences of fields whose names matches 34F, or Collections.emptyList() if none is found. Multiple occurrences of field 34F at MT942 are expected at one sequence or across several sequences.
        Returns:
        a List of Field34F objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField61

        public java.util.List<Field61> getField61()
        Iterates through block4 fields and return all occurrences of fields whose names matches 61, or Collections.emptyList() if none is found. Multiple occurrences of field 61 at MT942 are expected at one sequence or across several sequences.
        Returns:
        a List of Field61 objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField86

        public java.util.List<Field86> getField86()
        Iterates through block4 fields and return all occurrences of fields whose names matches 86, or Collections.emptyList() if none is found. Multiple occurrences of field 86 at MT942 are expected at one sequence or across several sequences.
        Returns:
        a List of Field86 objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)