Package com.prowidesoftware.swift.model.mt.mt3xx

Class MT370

  • All Implemented Interfaces:
    JsonSerializable, java.io.Serializable
    @Generated
public class MT370
extends AbstractMT
implements java.io.Serializable
    MT 370 - Netting Position Advice.

    SWIFT MT370 (ISO 15022) message structure:

    • Sequence A - General Information (M)
      • Field 16 R (M)
      • Field 20 C (M)
      • Field 23 G (M)
      • Field 98 A,C,E (O)
      • Sequence A1 - Linkages (O) (repetitive)
        • Field 16 R (M)
        • Field 20 C (M)
        • Field 16 S (M)
      • Field 95 P (M)
      • Sequence A2 - Order Party (O)
        • Field 16 R (M)
        • Field 95 P,Q,R (M)
        • Field 97 A (O)
        • Field 16 S (M)
      • Field 95 P (M)
      • Field 16 S (M)
    • Sequence B - Net Position Details (M)
      • Field 16 R (M)
      • Field 20 C (M)
      • Field 98 A,C (O)
      • Field 97 A (O)
      • Field 19 A (M)
      • Field 22 H (M)
      • Field 98 A (M)
      • Field 99 A,C (O)
      • Field 22 F (O) (repetitive)
      • Field 70 E (O) (repetitive)
      • Sequence B1 - Cash Parties (O) (repetitive)
        • Field 16 R (M)
        • Field 95 P,Q,R (M)
        • Field 97 A (O)
        • Field 16 S (M)
      • Field 16 S (M)

    This source code is specific to release SRU 2023

    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

      • MT370

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

      • MT370

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

      • MT370

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

      • MT370

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

      • MT370

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

      • MT370

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

      • MT370

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

      • parse

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

      • parse

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

      • getField23G

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

      • getField98E

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

      • getField19A

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

      • getField22H

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

      • getField99A

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

      • getField99C

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

      • getField16R

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

      • getField20C

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

      • getField16S

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

      • getField95P

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

      • getField98A

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

      • getField98C

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

      • getField97A

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

      • getField22F

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

      • getField70E

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

      • getField95Q

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

      • getField95R

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

      • getSequenceA

        @SequenceStyle(GENERATED_16RS)
public MT370.SequenceA getSequenceA()
        Get the single occurrence of SequenceA delimited by 16R/16S the value of SequenceA#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Returns:
        the found sequence or an empty sequence if none is found
        See Also:
        MT370.SequenceA.START_END_16RS

      • getSequenceGENL

        public MT370.SequenceA getSequenceGENL()
        Same as getSequenceA using the sequence delimiter field qualifier
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceA()

      • getSequenceA

        @SequenceStyle(GENERATED_16RS)
public static MT370.SequenceA getSequenceA​(SwiftTagListBlock parentSequence)
        Get the single occurrence of SequenceA delimited by 16R/16S the value of SequenceA#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        7.7
        See Also:
        MT370.SequenceA.START_END_16RS

      • getSequenceGENL

        public static MT370.SequenceA getSequenceGENL​(SwiftTagListBlock parentSequence)
        Same as getSequenceA using the sequence delimiter field qualifier
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceA(SwiftTagListBlock)

      • getSequenceA1List

        @SequenceStyle(GENERATED_16RS)
public java.util.List<MT370.SequenceA1> getSequenceA1List()
        Get the list of SequenceA1 delimited by 16R/16S with value specified in MT370.SequenceA1.START_END_16RS.

        The presence of this method indicates that this sequence can occur more than once according to the Standard.

        Returns:
        the found sequences or an empty list if none is found
        See Also:
        MT370.SequenceA1.START_END_16RS

      • getSequenceLINKList

        public java.util.List<MT370.SequenceA1> getSequenceLINKList()
        Same as getSequenceA1List using the sequence delimiter field qualifier
        Returns:
        the found sequences or an empty list if none is found
        Since:
        9.2.18
        See Also:
        getSequenceA1List()

      • getSequenceA1List

        @SequenceStyle(GENERATED_16RS)
public static java.util.List<MT370.SequenceA1> getSequenceA1List​(SwiftTagListBlock parentSequence)
        Get the list of SequenceA1 delimited by 16R/16S with value specified in MT370.SequenceA1.START_END_16RS.

        The presence of this method indicates that this sequence can occur more than once according to the Standard.

        Parameters:
        parentSequence - a not null parent sequence to find SequenceA1 within it
        Returns:
        the found sequences or an empty list if none is found or parent sequence is null
        Since:
        7.7
        See Also:
        MT370.SequenceA1.START_END_16RS

      • getSequenceLINKList

        public static java.util.List<MT370.SequenceA1> getSequenceLINKList​(SwiftTagListBlock parentSequence)
        Same as getSequenceA1List using the sequence delimiter field qualifier
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA1 within it
        Returns:
        the found sequences or an empty list if none is found
        Since:
        9.2.18
        See Also:
        getSequenceA1List(SwiftTagListBlock)

      • getSequenceA2

        @SequenceStyle(GENERATED_16RS)
public MT370.SequenceA2 getSequenceA2()
        Get the single occurrence of SequenceA2 delimited by 16R/16S the value of SequenceA2#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Returns:
        the found sequence or an empty sequence if none is found
        See Also:
        MT370.SequenceA2.START_END_16RS

      • getSequenceORDRPRTY

        public MT370.SequenceA2 getSequenceORDRPRTY()
        Same as getSequenceA2 using the sequence delimiter field qualifier
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceA2()

      • getSequenceA2

        @SequenceStyle(GENERATED_16RS)
public static MT370.SequenceA2 getSequenceA2​(SwiftTagListBlock parentSequence)
        Get the single occurrence of SequenceA2 delimited by 16R/16S the value of SequenceA2#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA2 within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        7.7
        See Also:
        MT370.SequenceA2.START_END_16RS

      • getSequenceORDRPRTY

        public static MT370.SequenceA2 getSequenceORDRPRTY​(SwiftTagListBlock parentSequence)
        Same as getSequenceA2 using the sequence delimiter field qualifier
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA2 within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceA2(SwiftTagListBlock)

      • getSequenceB

        @SequenceStyle(GENERATED_16RS)
public MT370.SequenceB getSequenceB()
        Get the single occurrence of SequenceB delimited by 16R/16S the value of SequenceB#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Returns:
        the found sequence or an empty sequence if none is found
        See Also:
        MT370.SequenceB.START_END_16RS

      • getSequenceNETPOS

        public MT370.SequenceB getSequenceNETPOS()
        Same as getSequenceB using the sequence delimiter field qualifier
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceB()

      • getSequenceB

        @SequenceStyle(GENERATED_16RS)
public static MT370.SequenceB getSequenceB​(SwiftTagListBlock parentSequence)
        Get the single occurrence of SequenceB delimited by 16R/16S the value of SequenceB#START_END_16RS. The presence of this method indicates that this sequence can occur only once according to the Standard.
        Parameters:
        parentSequence - a not null parent sequence to find SequenceB within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        7.7
        See Also:
        MT370.SequenceB.START_END_16RS

      • getSequenceNETPOS

        public static MT370.SequenceB getSequenceNETPOS​(SwiftTagListBlock parentSequence)
        Same as getSequenceB using the sequence delimiter field qualifier
        Parameters:
        parentSequence - a not null parent sequence to find SequenceB within it
        Returns:
        the found sequence or an empty sequence if none is found, never returns null
        Since:
        9.2.18
        See Also:
        getSequenceB(SwiftTagListBlock)

      • getSequenceB1List

        @SequenceStyle(GENERATED_16RS)
public java.util.List<MT370.SequenceB1> getSequenceB1List()
        Get the list of SequenceB1 delimited by 16R/16S with value specified in MT370.SequenceB1.START_END_16RS.

        The presence of this method indicates that this sequence can occur more than once according to the Standard.

        Returns:
        the found sequences or an empty list if none is found
        See Also:
        MT370.SequenceB1.START_END_16RS

      • getSequenceCSHPRTYList

        public java.util.List<MT370.SequenceB1> getSequenceCSHPRTYList()
        Same as getSequenceB1List using the sequence delimiter field qualifier
        Returns:
        the found sequences or an empty list if none is found
        Since:
        9.2.18
        See Also:
        getSequenceB1List()

      • getSequenceB1List

        @SequenceStyle(GENERATED_16RS)
public static java.util.List<MT370.SequenceB1> getSequenceB1List​(SwiftTagListBlock parentSequence)
        Get the list of SequenceB1 delimited by 16R/16S with value specified in MT370.SequenceB1.START_END_16RS.

        The presence of this method indicates that this sequence can occur more than once according to the Standard.

        Parameters:
        parentSequence - a not null parent sequence to find SequenceB1 within it
        Returns:
        the found sequences or an empty list if none is found or parent sequence is null
        Since:
        7.7
        See Also:
        MT370.SequenceB1.START_END_16RS

      • getSequenceCSHPRTYList

        public static java.util.List<MT370.SequenceB1> getSequenceCSHPRTYList​(SwiftTagListBlock parentSequence)
        Same as getSequenceB1List using the sequence delimiter field qualifier
        Parameters:
        parentSequence - a not null parent sequence to find SequenceB1 within it
        Returns:
        the found sequences or an empty list if none is found
        Since:
        9.2.18
        See Also:
        getSequenceB1List(SwiftTagListBlock)