Class MT798
- java.lang.Object
-
- com.prowidesoftware.swift.model.AbstractMessage
-
- com.prowidesoftware.swift.model.mt.AbstractMT
-
- com.prowidesoftware.swift.model.mt.mt7xx.MT798
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
@Generated public class MT798 extends AbstractMT implements java.io.Serializable
MT 798 - Proprietary Message.SWIFT MT798 (ISO 15022) message structure:
- Field 20 (M)
- Field 12 (M)
- Field 77 E (M)
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 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 MT798()
Creates and initializes a new MT798 input message setting TEST BICS as sender and receiver.MT798(MtSwiftMessage m)
Creates an MT798 initialized with the parameter MtSwiftMessage.MT798(SwiftMessage m)
Creates an MT798 initialized with the parameter SwiftMessage.MT798(java.io.File file)
Creates a new MT798 by parsing a file with the message content in its swift FIN format.MT798(java.io.InputStream stream)
Creates a new MT798 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.MT798(java.lang.String fin)
Creates a new MT798 by parsing a String with the message content in its swift FIN format.MT798(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT798 input message from sender to receiver.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MT798
append(Field... fields)
Add all the fields to the end of the block4.MT798
append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.MT798
append(Tag... tags)
Add all tags to the end of the block4.static MT798
fromJson(java.lang.String json)
Creates an MT798 messages from its JSON representation.Field12
getField12()
Iterates through block4 fields and return the first one whose name matches 12, or null if none is found.Field20
getField20()
Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.Field77E
getField77E()
Iterates through block4 fields and return the first one whose name matches 77E, or null if none is found.java.lang.String
getMessageType()
Returns this MT number.SwiftMessage
getSubMessage()
Creates a new messages with the content of the enclosed sub-message type.static MT798
parse(MtSwiftMessage m)
Creates an MT798 initialized with the parameter MtSwiftMessage.static MT798
parse(java.io.File file)
Creates a new MT798 by parsing a file with the message content in its swift FIN format.static MT798
parse(java.io.InputStream stream)
Creates a new MT798 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.static MT798
parse(java.lang.String fin)
Creates a new MT798 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
-
-
-
-
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
-
MT798
public MT798(SwiftMessage m)
Creates an MT798 initialized with the parameter SwiftMessage.- Parameters:
m
- swift message with the MT798 content
-
MT798
public MT798(MtSwiftMessage m)
Creates an MT798 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT798 content, the parameter can not be null- See Also:
MT798(String)
-
MT798
public MT798()
Creates and initializes a new MT798 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.- Since:
- 7.6
-
MT798
public MT798(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT798 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 charactersreceiver
- the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters- Since:
- 7.7
-
MT798
public MT798(java.lang.String fin)
Creates a new MT798 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
-
MT798
public MT798(java.io.InputStream stream) throws java.io.IOException
Creates a new MT798 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
-
MT798
public MT798(java.io.File file) throws java.io.IOException
Creates a new MT798 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 MT798 parse(MtSwiftMessage m)
Creates an MT798 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT798 content- Returns:
- the created object or null if the parameter is null
- Since:
- 7.7
- See Also:
MT798(String)
-
parse
public static MT798 parse(java.lang.String fin)
Creates a new MT798 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT798 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 MT798 or null if fin is null
- Since:
- 7.7
-
parse
public static MT798 parse(java.io.InputStream stream) throws java.io.IOException
Creates a new MT798 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 MT798 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 MT798 parse(java.io.File file) throws java.io.IOException
Creates a new MT798 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 MT798 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 classAbstractMT
- Returns:
- the message type number of this MT
- Since:
- 6.4
-
append
public MT798 append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
block
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT798 append(Tag... tags)
Add all tags to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
tags
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT798 append(Field... fields)
Add all the fields to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
fields
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
fromJson
public static MT798 fromJson(java.lang.String json)
Creates an MT798 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 MT798 message- Returns:
- a new instance of MT798
- 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 MT798 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)
-
getField12
public Field12 getField12()
Iterates through block4 fields and return the first one whose name matches 12, or null if none is found. The first occurrence of field 12 at MT798 is expected to be the only one.- Returns:
- a Field12 object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField77E
public Field77E getField77E()
Iterates through block4 fields and return the first one whose name matches 77E, or null if none is found. The first occurrence of field 77E at MT798 is expected to be the only one.- Returns:
- a Field77E object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getSubMessage
public SwiftMessage getSubMessage()
Creates a new messages with the content of the enclosed sub-message type. The headers are a clone to the actual envelop MT798 headers, changing the message type in block 2 with the value of field 12 in the envelop. The block4 will contain all fields following 77E in the envelop (including for example the message index in 27A and customer reference in 21P when present). Notice the return type is aSwiftMessage
since this model has a very lenient structure. If the sub-message type is a well-formed and known MT you can further transform it into a specific MT object with theSwiftMessage.toMT()
method.- Returns:
- a model containing the fields from the enclosed sub message
- Since:
- 9.2.11
-
-