MT020 (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt0xx.MT020

All Implemented Interfaces:

JsonSerializable, java.io.Serializable
```
@Generated
public class MT020
extends AbstractMT
implements java.io.Serializable
```
MT 020 - Retrieval Request.
SWIFT MT020 (ISO 15022) message structure:
- Field 102 (M)
- Sequence _A - GPA or FIN choices (O)
  - Sequence _A1 - MIR (O)
    Field 251 (M)
  - Sequence _A2 - MIR range (O)
    Field 252 (M)
  - Sequence _A3 - MOR (O)
    Field 253 (M)
  - Sequence _A4 - MOR range (O)
    Field 254 (M)
  - Sequence _A5 - Message input type (O)
    Field 255 (M)
    
    Field 152 (O)
  - Sequence _A6 - Input time range (O)
    Field 257 (M)
    
    Field 152 (O)
  - Sequence _A7 - Message output type (O)
    Field 258 (M)
    
    Field 153 (O)
  - Sequence _A8 - Output time range (O)
    Field 260 (M)
    
    Field 153 (O)
  - Sequence _A9 - Category input type (O)
    Field 256 (M)
    
    Field 152 (O)
  - Sequence _A10 - Category output type (O)
    Field 259 (M)
    
    Field 153 (O)
  - Sequence _A11 - MUR input (O)
    Field 263 (M)
    
    Field 108 (M)
    
    Field 152 (O)
  - Sequence _A12 - MUR output (O)
    Field 264 (M)
    
    Field 108 (M)
    
    Field 153 (O)
This source code is specific to release SRU 2022
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
`MT020()` Creates and initializes a new MT020 input message setting TEST BICS as sender and receiver.
`MT020(java.io.File file)` Creates a new MT020 by parsing a file with the message content in its swift FIN format.
`MT020(java.io.InputStream stream)` Creates a new MT020 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`MT020(MtSwiftMessage m)` Creates an MT020 initialized with the parameter MtSwiftMessage.
`MT020(java.lang.String fin)` Creates a new MT020 by parsing a String with the message content in its swift FIN format.
`MT020(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT020 input message from sender to receiver.
`MT020(SwiftMessage m)` Creates an MT020 initialized with the parameter SwiftMessage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT020`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT020`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT020`	`append(Tag... tags)` Add all tags to the end of the block4.
`static MT020`	`fromJson(java.lang.String json)` Creates an MT020 messages from its JSON representation.
`Field102`	`getField102()` Iterates through block4 fields and return the first one whose name matches 102, or null if none is found.
`java.util.List<Field108>`	`getField108()` Iterates through block4 fields and return all occurrences of fields whose names matches 108, or `Collections.emptyList()` if none is found.
`java.util.List<Field152>`	`getField152()` Iterates through block4 fields and return all occurrences of fields whose names matches 152, or `Collections.emptyList()` if none is found.
`java.util.List<Field153>`	`getField153()` Iterates through block4 fields and return all occurrences of fields whose names matches 153, or `Collections.emptyList()` if none is found.
`Field251`	`getField251()` Iterates through block4 fields and return the first one whose name matches 251, or null if none is found.
`Field252`	`getField252()` Iterates through block4 fields and return the first one whose name matches 252, or null if none is found.
`Field253`	`getField253()` Iterates through block4 fields and return the first one whose name matches 253, or null if none is found.
`Field254`	`getField254()` Iterates through block4 fields and return the first one whose name matches 254, or null if none is found.
`Field255`	`getField255()` Iterates through block4 fields and return the first one whose name matches 255, or null if none is found.
`Field256`	`getField256()` Iterates through block4 fields and return the first one whose name matches 256, or null if none is found.
`Field257`	`getField257()` Iterates through block4 fields and return the first one whose name matches 257, or null if none is found.
`Field258`	`getField258()` Iterates through block4 fields and return the first one whose name matches 258, or null if none is found.
`Field259`	`getField259()` Iterates through block4 fields and return the first one whose name matches 259, or null if none is found.
`Field260`	`getField260()` Iterates through block4 fields and return the first one whose name matches 260, or null if none is found.
`Field263`	`getField263()` Iterates through block4 fields and return the first one whose name matches 263, or null if none is found.
`Field264`	`getField264()` Iterates through block4 fields and return the first one whose name matches 264, or null if none is found.
`java.lang.String`	`getMessageType()` Returns this MT number.
`static MT020`	`parse(java.io.File file)` Creates a new MT020 by parsing a file with the message content in its swift FIN format.
`static MT020`	`parse(java.io.InputStream stream)` Creates a new MT020 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`static MT020`	`parse(MtSwiftMessage m)` Creates an MT020 initialized with the parameter MtSwiftMessage.
`static MT020`	`parse(java.lang.String fin)` Creates a new MT020 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
  - MT020
```
public MT020(SwiftMessage m)
```
    Creates an MT020 initialized with the parameter SwiftMessage.
    
    Parameters:
    
    m - swift message with the MT020 content
  - MT020
```
public MT020(MtSwiftMessage m)
```
    Creates an MT020 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT020 content, the parameter can not be null
    
    See Also:
    
    MT020(String)
  - MT020
```
public MT020()
```
    Creates and initializes a new MT020 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT020
```
public MT020(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT020 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
  - MT020
```
public MT020(java.lang.String fin)
```
    Creates a new MT020 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
  - MT020
```
public MT020(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT020 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
  - MT020
```
public MT020(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT020 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 MT020 parse(MtSwiftMessage m)
```
    Creates an MT020 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT020 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT020(String)
  - parse
```
public static MT020 parse(java.lang.String fin)
```
    Creates a new MT020 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT020 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 MT020 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT020 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT020 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 MT020 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 MT020 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT020 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 MT020 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 MT020 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 MT020 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 MT020 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 MT020 fromJson(java.lang.String json)
```
    Creates an MT020 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 MT020 message
    
    Returns:
    
    a new instance of MT020
    
    Since:
    
    7.10.3
  - getField102
```
public Field102 getField102()
```
    Iterates through block4 fields and return the first one whose name matches 102, or null if none is found. The first occurrence of field 102 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field102 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField251
```
public Field251 getField251()
```
    Iterates through block4 fields and return the first one whose name matches 251, or null if none is found. The first occurrence of field 251 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field251 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField252
```
public Field252 getField252()
```
    Iterates through block4 fields and return the first one whose name matches 252, or null if none is found. The first occurrence of field 252 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field252 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField253
```
public Field253 getField253()
```
    Iterates through block4 fields and return the first one whose name matches 253, or null if none is found. The first occurrence of field 253 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field253 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField254
```
public Field254 getField254()
```
    Iterates through block4 fields and return the first one whose name matches 254, or null if none is found. The first occurrence of field 254 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field254 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField255
```
public Field255 getField255()
```
    Iterates through block4 fields and return the first one whose name matches 255, or null if none is found. The first occurrence of field 255 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field255 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField257
```
public Field257 getField257()
```
    Iterates through block4 fields and return the first one whose name matches 257, or null if none is found. The first occurrence of field 257 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field257 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField258
```
public Field258 getField258()
```
    Iterates through block4 fields and return the first one whose name matches 258, or null if none is found. The first occurrence of field 258 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field258 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField260
```
public Field260 getField260()
```
    Iterates through block4 fields and return the first one whose name matches 260, or null if none is found. The first occurrence of field 260 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field260 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField256
```
public Field256 getField256()
```
    Iterates through block4 fields and return the first one whose name matches 256, or null if none is found. The first occurrence of field 256 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field256 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField259
```
public Field259 getField259()
```
    Iterates through block4 fields and return the first one whose name matches 259, or null if none is found. The first occurrence of field 259 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field259 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField263
```
public Field263 getField263()
```
    Iterates through block4 fields and return the first one whose name matches 263, or null if none is found. The first occurrence of field 263 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field263 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField264
```
public Field264 getField264()
```
    Iterates through block4 fields and return the first one whose name matches 264, or null if none is found. The first occurrence of field 264 at MT020 is expected to be the only one.
    
    Returns:
    
    a Field264 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField152
```
public java.util.List<Field152> getField152()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 152, or Collections.emptyList() if none is found. Multiple occurrences of field 152 at MT020 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field152 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField153
```
public java.util.List<Field153> getField153()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 153, or Collections.emptyList() if none is found. Multiple occurrences of field 153 at MT020 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field153 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField108
```
public java.util.List<Field108> getField108()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 108, or Collections.emptyList() if none is found. Multiple occurrences of field 108 at MT020 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field108 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)

Class MT020

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

Constructor Detail

MT020

MT020

MT020

MT020

MT020

MT020

MT020

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

fromJson

getField102

getField251

getField252

getField253

getField254

getField255

getField257

getField258

getField260

getField256

getField259

getField263

getField264

getField152

getField153

getField108