com.prowidesoftware.swift.model.mt.mt9xx

Class MT970

java.lang.Object

com.prowidesoftware.swift.model.AbstractMessage

com.prowidesoftware.swift.model.mt.AbstractMT

com.prowidesoftware.swift.model.mt.mt9xx.MT970

All Implemented Interfaces:

JsonSerializable, java.io.Serializable

@Generated
public class MT970
extends AbstractMT
implements java.io.Serializable

MT 970 - Netting Statement.

SWIFT MT970 (ISO 15022) message structure:

• Field 20 (M)
• Field 25 (M)
• Field 28 C (M)
• Field 60 F,M (M)
• Field 61 (O) (repetitive)
• Field 62 F,M (M)
• Field 64 (O)

This source code is specific to release SRU 2023

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

See Also:

Serialized Form

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
MT970	append(Field... fields) Add all the fields to the end of the block4.
MT970	append(SwiftTagListBlock block) Add all tags from block to the end of the block4.
MT970	append(Tag... tags) Add all tags to the end of the block4.
static MT970	fromJson(java.lang.String json) Creates an MT970 messages from its JSON representation.
Field20	getField20() Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.
Field25	getField25() Iterates through block4 fields and return the first one whose name matches 25, or null if none is found.
Field28C	getField28C() Iterates through block4 fields and return the first one whose name matches 28C, or null if none is found.
Field60F	getField60F() Iterates through block4 fields and return the first one whose name matches 60F, or null if none is found.
Field60M	getField60M() Iterates through block4 fields and return the first one whose name matches 60M, or null if none is found.
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.
Field62F	getField62F() Iterates through block4 fields and return the first one whose name matches 62F, or null if none is found.
Field62M	getField62M() Iterates through block4 fields and return the first one whose name matches 62M, or null if none is found.
Field64	getField64() Iterates through block4 fields and return the first one whose name matches 64, or null if none is found.
java.lang.String	getMessageType() Returns this MT number.
static MT970	parse(java.io.File file) Creates a new MT970 by parsing a file with the message content in its swift FIN format.
static MT970	parse(java.io.InputStream stream) Creates a new MT970 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
static MT970	parse(MtSwiftMessage m) Creates an MT970 initialized with the parameter MtSwiftMessage.
static MT970	parse(java.lang.String fin) Creates a new MT970 by parsing a String with the message content in its swift FIN format.

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

addField, containsSequence, containsSequenceList, create, create, getApplicationId, getFields, getLogicalTerminal, getMessagePriority, getMtId, getReceiver, getSender, getSequence, getSequence, getSequence, getSequenceList, getSequenceList, getSequenceNumber, getServiceId, getSessionNumber, getSignature, getSwiftMessage, getSwiftMessageNotNullOrException, getVariant, isIncoming, isInput, isOutgoing, isOutput, isType, message, nameFromClass, read, setReceiver, setReceiver, setSender, setSender, setSignature, setSwiftMessage, tag, tags, toJson, toString, write, write, xml

Methods inherited from class com.prowidesoftware.swift.model.AbstractMessage

getMessageStandardType, isMT, isMX

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

MT970

public MT970(SwiftMessage m)

Creates an MT970 initialized with the parameter SwiftMessage.

Parameters:

m - swift message with the MT970 content

MT970

public MT970(MtSwiftMessage m)

Creates an MT970 initialized with the parameter MtSwiftMessage.

Parameters:

m - swift message with the MT970 content, the parameter can not be null

See Also:

MT970(String)

MT970

public MT970()

Creates and initializes a new MT970 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.

Since:

7.6

MT970

public MT970(java.lang.String sender,
             java.lang.String receiver)

Creates and initializes a new MT970 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

MT970

public MT970(java.lang.String fin)

Creates a new MT970 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

MT970

public MT970(java.io.InputStream stream)
      throws java.io.IOException

Creates a new MT970 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

MT970

public MT970(java.io.File file)
      throws java.io.IOException

Creates a new MT970 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 MT970 parse(MtSwiftMessage m)

Creates an MT970 initialized with the parameter MtSwiftMessage.

Parameters:

m - swift message with the MT970 content

Returns:

the created object or null if the parameter is null

Since:

7.7

See Also:

MT970(String)

parse

public static MT970 parse(java.lang.String fin)

Creates a new MT970 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT970 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 MT970 or null if fin is null

Since:

7.7

parse

public static MT970 parse(java.io.InputStream stream)
                   throws java.io.IOException

Creates a new MT970 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 MT970 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 MT970 parse(java.io.File file)
                   throws java.io.IOException

Creates a new MT970 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 MT970 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 MT970 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 MT970 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 MT970 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 MT970 fromJson(java.lang.String json)

Creates an MT970 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 MT970 message

Returns:

a new instance of MT970

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

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

getField60F

public Field60F getField60F()

Iterates through block4 fields and return the first one whose name matches 60F, or null if none is found. The first occurrence of field 60F at MT970 is expected to be the only one.

Returns:

a Field60F object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(String)

getField60M

public Field60M getField60M()

Iterates through block4 fields and return the first one whose name matches 60M, or null if none is found. The first occurrence of field 60M at MT970 is expected to be the only one.

Returns:

a Field60M object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(String)

getField62F

public Field62F getField62F()

Iterates through block4 fields and return the first one whose name matches 62F, or null if none is found. The first occurrence of field 62F at MT970 is expected to be the only one.

Returns:

a Field62F object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(String)

getField62M

public Field62M getField62M()

Iterates through block4 fields and return the first one whose name matches 62M, or null if none is found. The first occurrence of field 62M at MT970 is expected to be the only one.

Returns:

a Field62M object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(String)

getField64

public Field64 getField64()

Iterates through block4 fields and return the first one whose name matches 64, or null if none is found. The first occurrence of field 64 at MT970 is expected to be the only one.

Returns:

a Field64 object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(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 MT970 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)