Class MT605

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

    @Generated
    public class MT605
    extends AbstractMT
    implements java.io.Serializable
    MT 605 - Commodity Notice to Receive.

    SWIFT MT605 (ISO 15022) message structure:

    • Field 20 (M)
    • Field 26 C (M)
    • Field 25 (O)
    • Field 30 (M)
    • Field 72 (O)
    • Sequence Loop1 (M) (repetitive)
      • Field 21 (M)
      • Field 23 (M)
      • Field 26 D (O)
      • Field 32 F (M)
      • Field 82 A,B,D (O)
      • Field 86 A,B,D (O)
      • Field 87 A,B,D (M)
      • Field 88 A,B,D (O)
      • Field 72 (O)

    This source code is specific to release SRU 2022

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

    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MT605.Loop1
      Class to model Sequence "Loop1" in MT 605.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      Constant for MT name, this is part of the classname, after MT.
      static int SRU
      Constant identifying the SRU to which this class belongs to.
      • Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

        m
    • Constructor Summary

      Constructors 
      Constructor Description
      MT605()
      Creates and initializes a new MT605 input message setting TEST BICS as sender and receiver.
      MT605​(MtSwiftMessage m)
      Creates an MT605 initialized with the parameter MtSwiftMessage.
      MT605​(SwiftMessage m)
      Creates an MT605 initialized with the parameter SwiftMessage.
      MT605​(java.io.File file)
      Creates a new MT605 by parsing a file with the message content in its swift FIN format.
      MT605​(java.io.InputStream stream)
      Creates a new MT605 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
      MT605​(java.lang.String fin)
      Creates a new MT605 by parsing a String with the message content in its swift FIN format.
      MT605​(java.lang.String sender, java.lang.String receiver)
      Creates and initializes a new MT605 input message from sender to receiver.
    • 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

      • MT605

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

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

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

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

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

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

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

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

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

        public Field26C getField26C()
        Iterates through block4 fields and return the first one whose name matches 26C, or null if none is found. The first occurrence of field 26C at MT605 is expected to be the only one.
        Returns:
        a Field26C 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 MT605 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)
      • getField30

        public Field30 getField30()
        Iterates through block4 fields and return the first one whose name matches 30, or null if none is found. The first occurrence of field 30 at MT605 is expected to be the only one.
        Returns:
        a Field30 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 java.util.List<Field21> getField21()
        Iterates through block4 fields and return all occurrences of fields whose names matches 21, or Collections.emptyList() if none is found. Multiple occurrences of field 21 at MT605 are expected at one sequence or across several sequences.
        Returns:
        a List of Field21 objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField23

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public java.util.List<MT605.Loop1> getLoop1List()
        Get the list of Loop1 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
        Returns:
        the found sequences or an empty list if none is found
        See Also:
        SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
      • getLoop1List

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public static java.util.List<MT605.Loop1> getLoop1List​(SwiftTagListBlock parentSequence)
        Get the list of Loop1 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
        Parameters:
        parentSequence - a not null parent sequence to find Loop1 within it
        Returns:
        the found sequences or an empty list if none is found or parent sequence is null
        Since:
        7.7
        See Also:
        SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])