MT023 (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, java.io.Serializable
```
@Generated
public class MT023
extends AbstractMT
implements java.io.Serializable
```
MT 023 - Retrieved Message (History).
SWIFT MT023 (ISO 15022) message structure:
- Field 202 (M)
- Field 203 (M)
- Field 280 (M) (repetitive)
- Field 108 (O) (repetitive)
- Field 431 (O) (repetitive)
- Field 281 (O) (repetitive)
- Sequence _A - Next Retrieval Criteria (M)
  - Sequence _A1 - MIR range (O)
    Field 252 (M)
  - Sequence _A2 - MOR range (O)
    Field 254 (M)
  - Sequence _A3 - Message input type (O)
    Field 255 (M)
    
    Field 152 (O)
  - Sequence _A4 - Category input type (O)
    Field 256 (M)
    
    Field 152 (O)
  - Sequence _A5 - Input time range (O)
    Field 257 (M)
    
    Field 152 (O)
  - Sequence _A6 - Message output type (O)
    Field 258 (M)
    
    Field 153 (O)
  - Sequence _A7 - Category output type (O)
    Field 259 (M)
    
    Field 153 (O)
  - Sequence _A8 - Output time range (O)
    Field 260 (M)
    
    Field 153 (O)
  - Sequence _A9 - Retrieval error code (O)
    Field 421 (M)
    
    Field 152 (O)
  - Sequence _A10 - Retrieval error code (O)
    Field 421 (M)
    
    Field 153 (O)
- Sequence _B (O)
  - Field 202 (M)
  - Field 203 (M)
  - Field 421 (M)
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
`MT023()` Creates and initializes a new MT023 input message setting TEST BICS as sender and receiver.
`MT023(java.io.File file)` Creates a new MT023 by parsing a file with the message content in its swift FIN format.
`MT023(java.io.InputStream stream)` Creates a new MT023 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`MT023(MtSwiftMessage m)` Creates an MT023 initialized with the parameter MtSwiftMessage.
`MT023(java.lang.String fin)` Creates a new MT023 by parsing a String with the message content in its swift FIN format.
`MT023(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT023 input message from sender to receiver.
`MT023(SwiftMessage m)` Creates an MT023 initialized with the parameter SwiftMessage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT023`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT023`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT023`	`append(Tag... tags)` Add all tags to the end of the block4.
`static MT023`	`fromJson(java.lang.String json)` Creates an MT023 messages from its JSON representation.
`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.
`java.util.List<Field202>`	`getField202()` Iterates through block4 fields and return all occurrences of fields whose names matches 202, or `Collections.emptyList()` if none is found.
`java.util.List<Field203>`	`getField203()` Iterates through block4 fields and return all occurrences of fields whose names matches 203, or `Collections.emptyList()` 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.
`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.
`java.util.List<Field280>`	`getField280()` Iterates through block4 fields and return all occurrences of fields whose names matches 280, or `Collections.emptyList()` if none is found.
`java.util.List<Field281>`	`getField281()` Iterates through block4 fields and return all occurrences of fields whose names matches 281, or `Collections.emptyList()` if none is found.
`java.util.List<Field421>`	`getField421()` Iterates through block4 fields and return all occurrences of fields whose names matches 421, or `Collections.emptyList()` if none is found.
`java.util.List<Field431>`	`getField431()` Iterates through block4 fields and return all occurrences of fields whose names matches 431, or `Collections.emptyList()` if none is found.
`java.lang.String`	`getMessageType()` Returns this MT number.
`static MT023`	`parse(java.io.File file)` Creates a new MT023 by parsing a file with the message content in its swift FIN format.
`static MT023`	`parse(java.io.InputStream stream)` Creates a new MT023 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`static MT023`	`parse(MtSwiftMessage m)` Creates an MT023 initialized with the parameter MtSwiftMessage.
`static MT023`	`parse(java.lang.String fin)` Creates a new MT023 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
  - MT023
```
public MT023(SwiftMessage m)
```
    Creates an MT023 initialized with the parameter SwiftMessage.
    
    Parameters:
    
    m - swift message with the MT023 content
  - MT023
```
public MT023(MtSwiftMessage m)
```
    Creates an MT023 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT023 content, the parameter can not be null
    
    See Also:
    
    MT023(String)
  - MT023
```
public MT023()
```
    Creates and initializes a new MT023 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT023
```
public MT023(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT023 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
  - MT023
```
public MT023(java.lang.String fin)
```
    Creates a new MT023 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
  - MT023
```
public MT023(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT023 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
  - MT023
```
public MT023(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT023 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 MT023 parse(MtSwiftMessage m)
```
    Creates an MT023 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT023 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT023(String)
  - parse
```
public static MT023 parse(java.lang.String fin)
```
    Creates a new MT023 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT023 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 MT023 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT023 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT023 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 MT023 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 MT023 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT023 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 MT023 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 MT023 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 MT023 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 MT023 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 MT023 fromJson(java.lang.String json)
```
    Creates an MT023 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 MT023 message
    
    Returns:
    
    a new instance of MT023
    
    Since:
    
    7.10.3
  - 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 MT023 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)
  - 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 MT023 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 MT023 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)
  - 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 MT023 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)
  - 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 MT023 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 MT023 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)
  - 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 MT023 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)
  - 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 MT023 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)
  - getField280
```
public java.util.List<Field280> getField280()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 280, or Collections.emptyList() if none is found. Multiple occurrences of field 280 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field280 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 MT023 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)
  - getField431
```
public java.util.List<Field431> getField431()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 431, or Collections.emptyList() if none is found. Multiple occurrences of field 431 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field431 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField281
```
public java.util.List<Field281> getField281()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 281, or Collections.emptyList() if none is found. Multiple occurrences of field 281 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field281 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(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 MT023 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 MT023 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)
  - getField421
```
public java.util.List<Field421> getField421()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 421, or Collections.emptyList() if none is found. Multiple occurrences of field 421 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field421 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField202
```
public java.util.List<Field202> getField202()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 202, or Collections.emptyList() if none is found. Multiple occurrences of field 202 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field202 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField203
```
public java.util.List<Field203> getField203()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 203, or Collections.emptyList() if none is found. Multiple occurrences of field 203 at MT023 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field203 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 MT023

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

MT023

MT023

MT023

MT023

MT023

MT023

MT023

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

fromJson

getField252

getField254

getField255

getField256

getField257

getField258

getField259

getField260

getField280

getField108

getField431

getField281

getField152

getField153

getField421

getField202

getField203