Class MT111
- java.lang.Object
-
- com.prowidesoftware.swift.model.AbstractMessage
-
- com.prowidesoftware.swift.model.mt.AbstractMT
-
- com.prowidesoftware.swift.model.mt.mt1xx.MT111
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
@Generated public class MT111 extends AbstractMT implements java.io.Serializable
MT 111 - Request for Stop Payment of a Cheque.SWIFT MT111 (ISO 15022) message structure:
- Field 20 (M)
- Field 21 (M)
- Field 30 (M)
- Field 32 A,B (M)
- Field 52 A,B,D (O)
- Field 59 (O)
- Field 75 (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 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 MT111()
Creates and initializes a new MT111 input message setting TEST BICS as sender and receiver.MT111(MtSwiftMessage m)
Creates an MT111 initialized with the parameter MtSwiftMessage.MT111(SwiftMessage m)
Creates an MT111 initialized with the parameter SwiftMessage.MT111(java.io.File file)
Creates a new MT111 by parsing a file with the message content in its swift FIN format.MT111(java.io.InputStream stream)
Creates a new MT111 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.MT111(java.lang.String fin)
Creates a new MT111 by parsing a String with the message content in its swift FIN format.MT111(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT111 input message from sender to receiver.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MT111
append(Field... fields)
Add all the fields to the end of the block4.MT111
append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.MT111
append(Tag... tags)
Add all tags to the end of the block4.static MT111
fromJson(java.lang.String json)
Creates an MT111 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.Field21
getField21()
Iterates through block4 fields and return the first one whose name matches 21, or null if none is found.Field30
getField30()
Iterates through block4 fields and return the first one whose name matches 30, or null if none is found.Field32A
getField32A()
Iterates through block4 fields and return the first one whose name matches 32A, or null if none is found.Field32B
getField32B()
Iterates through block4 fields and return the first one whose name matches 32B, or null if none is found.Field52A
getField52A()
Iterates through block4 fields and return the first one whose name matches 52A, or null if none is found.Field52B
getField52B()
Iterates through block4 fields and return the first one whose name matches 52B, or null if none is found.Field52D
getField52D()
Iterates through block4 fields and return the first one whose name matches 52D, or null if none is found.Field59
getField59()
Iterates through block4 fields and return the first one whose name matches 59, or null if none is found.Field75
getField75()
Iterates through block4 fields and return the first one whose name matches 75, or null if none is found.java.lang.String
getMessageType()
Returns this MT number.static MT111
parse(MtSwiftMessage m)
Creates an MT111 initialized with the parameter MtSwiftMessage.static MT111
parse(java.io.File file)
Creates a new MT111 by parsing a file with the message content in its swift FIN format.static MT111
parse(java.io.InputStream stream)
Creates a new MT111 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.static MT111
parse(java.lang.String fin)
Creates a new MT111 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
-
MT111
public MT111(SwiftMessage m)
Creates an MT111 initialized with the parameter SwiftMessage.- Parameters:
m
- swift message with the MT111 content
-
MT111
public MT111(MtSwiftMessage m)
Creates an MT111 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT111 content, the parameter can not be null- See Also:
MT111(String)
-
MT111
public MT111()
Creates and initializes a new MT111 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.- Since:
- 7.6
-
MT111
public MT111(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT111 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
-
MT111
public MT111(java.lang.String fin)
Creates a new MT111 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
-
MT111
public MT111(java.io.InputStream stream) throws java.io.IOException
Creates a new MT111 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
-
MT111
public MT111(java.io.File file) throws java.io.IOException
Creates a new MT111 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 MT111 parse(MtSwiftMessage m)
Creates an MT111 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT111 content- Returns:
- the created object or null if the parameter is null
- Since:
- 7.7
- See Also:
MT111(String)
-
parse
public static MT111 parse(java.lang.String fin)
Creates a new MT111 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT111 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 MT111 or null if fin is null
- Since:
- 7.7
-
parse
public static MT111 parse(java.io.InputStream stream) throws java.io.IOException
Creates a new MT111 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 MT111 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 MT111 parse(java.io.File file) throws java.io.IOException
Creates a new MT111 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 MT111 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 MT111 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 MT111 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 MT111 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 MT111 fromJson(java.lang.String json)
Creates an MT111 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 MT111 message- Returns:
- a new instance of MT111
- 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 MT111 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)
-
getField21
public Field21 getField21()
Iterates through block4 fields and return the first one whose name matches 21, or null if none is found. The first occurrence of field 21 at MT111 is expected to be the only one.- Returns:
- a Field21 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 MT111 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)
-
getField32A
public Field32A getField32A()
Iterates through block4 fields and return the first one whose name matches 32A, or null if none is found. The first occurrence of field 32A at MT111 is expected to be the only one.- Returns:
- a Field32A object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField32B
public Field32B getField32B()
Iterates through block4 fields and return the first one whose name matches 32B, or null if none is found. The first occurrence of field 32B at MT111 is expected to be the only one.- Returns:
- a Field32B object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField52A
public Field52A getField52A()
Iterates through block4 fields and return the first one whose name matches 52A, or null if none is found. The first occurrence of field 52A at MT111 is expected to be the only one.- Returns:
- a Field52A object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField52B
public Field52B getField52B()
Iterates through block4 fields and return the first one whose name matches 52B, or null if none is found. The first occurrence of field 52B at MT111 is expected to be the only one.- Returns:
- a Field52B object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField52D
public Field52D getField52D()
Iterates through block4 fields and return the first one whose name matches 52D, or null if none is found. The first occurrence of field 52D at MT111 is expected to be the only one.- Returns:
- a Field52D object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField59
public Field59 getField59()
Iterates through block4 fields and return the first one whose name matches 59, or null if none is found. The first occurrence of field 59 at MT111 is expected to be the only one.- Returns:
- a Field59 object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField75
public Field75 getField75()
Iterates through block4 fields and return the first one whose name matches 75, or null if none is found. The first occurrence of field 75 at MT111 is expected to be the only one.- Returns:
- a Field75 object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
-