MT083 (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, java.io.Serializable
```
@Generated
public class MT083
extends AbstractMT
implements java.io.Serializable
```
MT 083 - Undelivered Message Report at Cut-off Time.
SWIFT MT083 (ISO 15022) message structure:
- Field 202 (M)
- Field 203 (M)
- Field 171 (M)
- Field 175 (M)
- Field 301 (O)
- Sequence _A - Groups (M)
  - Sequence _A1 - Group 1 (O) (repetitive)
    Sequence _A1a - Group 1.1 (M)
    Field 335 (M)
    
    Field 108 (O)
    
    Sequence _A1b - Group 1.2 (O)
    Field 431 (M)
    
    Field 103 (M)
  - Sequence _A2 - Groups (O)
    Field 461 (M)
This source code is specific to release SRU 2024
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
`MT083()` Creates and initializes a new MT083 input message setting TEST BICS as sender and receiver.
`MT083(java.io.File file)` Creates a new MT083 by parsing a file with the message content in its swift FIN format.
`MT083(java.io.InputStream stream)` Creates a new MT083 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`MT083(MtSwiftMessage m)` Creates an MT083 initialized with the parameter MtSwiftMessage.
`MT083(java.lang.String fin)` Creates a new MT083 by parsing a String with the message content in its swift FIN format.
`MT083(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT083 input message from sender to receiver.
`MT083(SwiftMessage m)` Creates an MT083 initialized with the parameter SwiftMessage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT083`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT083`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT083`	`append(Tag... tags)` Add all tags to the end of the block4.
`static MT083`	`fromJson(java.lang.String json)` Creates an MT083 messages from its JSON representation.
`Field103`	`getField103()` Iterates through block4 fields and return the first one whose name matches 103, or null if none is found.
`Field108`	`getField108()` Iterates through block4 fields and return the first one whose name matches 108, or null if none is found.
`Field171`	`getField171()` Iterates through block4 fields and return the first one whose name matches 171, or null if none is found.
`Field175`	`getField175()` Iterates through block4 fields and return the first one whose name matches 175, or null if none is found.
`Field202`	`getField202()` Iterates through block4 fields and return the first one whose name matches 202, or null if none is found.
`Field203`	`getField203()` Iterates through block4 fields and return the first one whose name matches 203, or null if none is found.
`Field301`	`getField301()` Iterates through block4 fields and return the first one whose name matches 301, or null if none is found.
`Field335`	`getField335()` Iterates through block4 fields and return the first one whose name matches 335, or null if none is found.
`Field431`	`getField431()` Iterates through block4 fields and return the first one whose name matches 431, or null if none is found.
`Field461`	`getField461()` Iterates through block4 fields and return the first one whose name matches 461, or null if none is found.
`java.lang.String`	`getMessageType()` Returns this MT number.
`static MT083`	`parse(java.io.File file)` Creates a new MT083 by parsing a file with the message content in its swift FIN format.
`static MT083`	`parse(java.io.InputStream stream)` Creates a new MT083 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`static MT083`	`parse(MtSwiftMessage m)` Creates an MT083 initialized with the parameter MtSwiftMessage.
`static MT083`	`parse(java.lang.String fin)` Creates a new MT083 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
  - MT083
```
public MT083(SwiftMessage m)
```
    Creates an MT083 initialized with the parameter SwiftMessage.
    
    Parameters:
    
    m - swift message with the MT083 content
  - MT083
```
public MT083(MtSwiftMessage m)
```
    Creates an MT083 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT083 content, the parameter can not be null
    
    See Also:
    
    MT083(String)
  - MT083
```
public MT083()
```
    Creates and initializes a new MT083 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT083
```
public MT083(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT083 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
  - MT083
```
public MT083(java.lang.String fin)
```
    Creates a new MT083 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
  - MT083
```
public MT083(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT083 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
  - MT083
```
public MT083(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT083 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 MT083 parse(MtSwiftMessage m)
```
    Creates an MT083 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT083 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT083(String)
  - parse
```
public static MT083 parse(java.lang.String fin)
```
    Creates a new MT083 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT083 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 MT083 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT083 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT083 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 MT083 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 MT083 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT083 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 MT083 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 MT083 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 MT083 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 MT083 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 MT083 fromJson(java.lang.String json)
```
    Creates an MT083 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 MT083 message
    
    Returns:
    
    a new instance of MT083
    
    Since:
    
    7.10.3
  - getField202
```
public Field202 getField202()
```
    Iterates through block4 fields and return the first one whose name matches 202, or null if none is found. The first occurrence of field 202 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field202 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField203
```
public Field203 getField203()
```
    Iterates through block4 fields and return the first one whose name matches 203, or null if none is found. The first occurrence of field 203 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field203 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField171
```
public Field171 getField171()
```
    Iterates through block4 fields and return the first one whose name matches 171, or null if none is found. The first occurrence of field 171 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field171 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField175
```
public Field175 getField175()
```
    Iterates through block4 fields and return the first one whose name matches 175, or null if none is found. The first occurrence of field 175 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field175 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField301
```
public Field301 getField301()
```
    Iterates through block4 fields and return the first one whose name matches 301, or null if none is found. The first occurrence of field 301 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field301 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField335
```
public Field335 getField335()
```
    Iterates through block4 fields and return the first one whose name matches 335, or null if none is found. The first occurrence of field 335 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field335 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField108
```
public Field108 getField108()
```
    Iterates through block4 fields and return the first one whose name matches 108, or null if none is found. The first occurrence of field 108 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field108 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField431
```
public Field431 getField431()
```
    Iterates through block4 fields and return the first one whose name matches 431, or null if none is found. The first occurrence of field 431 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field431 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField103
```
public Field103 getField103()
```
    Iterates through block4 fields and return the first one whose name matches 103, or null if none is found. The first occurrence of field 103 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field103 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField461
```
public Field461 getField461()
```
    Iterates through block4 fields and return the first one whose name matches 461, or null if none is found. The first occurrence of field 461 at MT083 is expected to be the only one.
    
    Returns:
    
    a Field461 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)

Class MT083

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

MT083

MT083

MT083

MT083

MT083

MT083

MT083

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

fromJson

getField202

getField203

getField171

getField175

getField301

getField335

getField108

getField431

getField103

getField461