com.prowidesoftware.swift.model.mt.mt0xx

Class MT024

java.lang.Object

com.prowidesoftware.swift.model.AbstractMessage

com.prowidesoftware.swift.model.mt.AbstractMT

com.prowidesoftware.swift.model.mt.mt0xx.MT024

All Implemented Interfaces:

JsonSerializable, java.io.Serializable

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

MT 024 - Bulk Retrieval Request

SWIFT MT024 (ISO 15022) message structure:

• Field 140 (O)
• Field 142 (M)
• Field 143 (M)

This source code is specific to release SRU 2021

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
MT024() Creates and initializes a new MT024 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
MT024(java.io.File file) Creates a new MT024 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.
MT024(java.io.InputStream stream) Creates a new MT024 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.
MT024(MtSwiftMessage m) Creates an MT024 initialized with the parameter MtSwiftMessage.
MT024(java.lang.String fin) Creates a new MT024 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.
MT024(java.lang.String sender, java.lang.String receiver) Creates and initializes a new MT024 input message from sender to receiver. All mandatory header attributes are completed with default values.
MT024(SwiftMessage m) Creates an MT024 initialized with the parameter SwiftMessage

Method Summary

Modifier and Type	Method and Description
MT024	append(Field... fields) Add all the fields to the end of the block4.
MT024	append(SwiftTagListBlock block) Add all tags from block to the end of the block4.
MT024	append(Tag... tags) Add all tags to the end of the block4.
static MT024	fromJson(java.lang.String json) Creates an MT024 messages from its JSON representation.
Field140	getField140() Iterates through block4 fields and return the first one whose name matches 140, or null if none is found. The first occurrence of field 140 at MT024 is expected to be the only one.
Field142	getField142() Iterates through block4 fields and return the first one whose name matches 142, or null if none is found. The first occurrence of field 142 at MT024 is expected to be the only one.
Field143	getField143() Iterates through block4 fields and return the first one whose name matches 143, or null if none is found. The first occurrence of field 143 at MT024 is expected to be the only one.
java.lang.String	getMessageType() Returns this MT number
static MT024	parse(java.io.File file) Creates a new MT024 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.
static MT024	parse(java.io.InputStream stream) Creates a new MT024 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.
static MT024	parse(MtSwiftMessage m) Creates an MT024 initialized with the parameter MtSwiftMessage.
static MT024	parse(java.lang.String fin) Creates a new MT024 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT024 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.

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

MT024

public MT024(SwiftMessage m)

Creates an MT024 initialized with the parameter SwiftMessage

Parameters:

m - swift message with the MT024 content

MT024

public MT024(MtSwiftMessage m)

Creates an MT024 initialized with the parameter MtSwiftMessage.

Parameters:

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

See Also:

MT024(String)

MT024

public MT024()

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

Since:

7.6

MT024

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

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

MT024

public MT024(java.lang.String fin)

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

MT024

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

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

MT024

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

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

Creates an MT024 initialized with the parameter MtSwiftMessage.

Parameters:

m - swift message with the MT024 content

Returns:

the created object or null if the parameter is null

Since:

7.7

See Also:

MT024(String)

parse

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

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

Since:

7.7

parse

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

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

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

Creates an MT024 messages from its JSON representation.

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

Parameters:

json - a JSON representation of an MT024 message

Returns:

a new instance of MT024

Since:

7.10.3

getField140

public Field140 getField140()

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

Returns:

a Field140 object or null if the field is not found

Throws:

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

See Also:

SwiftTagListBlock.getTagByName(String)

getField142

public Field142 getField142()

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

Returns:

a Field142 object or null if the field is not found

Throws:

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

See Also:

SwiftTagListBlock.getTagByName(String)

getField143

public Field143 getField143()

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

Returns:

a Field143 object or null if the field is not found

Throws:

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

See Also:

SwiftTagListBlock.getTagByName(String)