MT581 (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt5xx.MT581

All Implemented Interfaces:

java.io.Serializable
```
@Generated
public class MT581
extends AbstractMT
implements java.io.Serializable
```
MT 581 -

SWIFT MT581 (ISO 15022) message structure:
- Field 20 (M)
- Field 21 (M)
- Field 23 (M)
- Field 30 (O)
- Field 35 H (M)
- Field 35 B (O)
- Field 80 C (M)
- Field 34 B (O)
- Field 72 (O)
This source code is specific to release SRU 2017

For additional resources check http://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
`MT581()` Creates and initializes a new MT581 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
`MT581(java.io.File file)` Creates a new MT581 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.
`MT581(java.io.InputStream stream)` Creates a new MT581 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.
`MT581(int messageType, java.lang.String sender, java.lang.String receiver)` Deprecated. Use instead `new MT581(sender, receiver)` instead
`MT581(MtSwiftMessage m)` Creates an MT581 initialized with the parameter MtSwiftMessage.
`MT581(java.lang.String fin)` Creates a new MT581 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.
`MT581(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT581 input message from sender to receiver. All mandatory header attributes are completed with default values.
`MT581(SwiftMessage m)` Creates an MT581 initialized with the parameter SwiftMessage

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT581`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT581`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT581`	`append(Tag... tags)` Add all tags to the end of the block4.
`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 MT581 is expected to be the only one.
`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 MT581 is expected to be the only one.
`Field23`	`getField23()` Iterates through block4 fields and return the first one whose name matches 23, or `null` if none is found. The first occurrence of field 23 at MT581 is expected to be the only one.
`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 MT581 is expected to be the only one.
`Field34B`	`getField34B()` Iterates through block4 fields and return the first one whose name matches 34B, or `null` if none is found. The first occurrence of field 34B at MT581 is expected to be the only one.
`Field35B`	`getField35B()` Iterates through block4 fields and return the first one whose name matches 35B, or `null` if none is found. The first occurrence of field 35B at MT581 is expected to be the only one.
`Field35H`	`getField35H()` Iterates through block4 fields and return the first one whose name matches 35H, or `null` if none is found. The first occurrence of field 35H at MT581 is expected to be the only one.
`Field72`	`getField72()` Iterates through block4 fields and return the first one whose name matches 72, or `null` if none is found. The first occurrence of field 72 at MT581 is expected to be the only one.
`Field80C`	`getField80C()` Iterates through block4 fields and return the first one whose name matches 80C, or `null` if none is found. The first occurrence of field 80C at MT581 is expected to be the only one.
`java.lang.String`	`getMessageType()` Returns this MT number
`static MT581`	`parse(java.io.File file)` Creates a new MT581 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.
`static MT581`	`parse(java.io.InputStream stream)` Creates a new MT581 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.
`static MT581`	`parse(MtSwiftMessage m)` Creates an MT581 initialized with the parameter MtSwiftMessage.
`static MT581`	`parse(java.lang.String fin)` Creates a new MT581 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT581 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.

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT
addField, containsSequence, containsSequenceList, create, create, FIN, getApplicationId, getLogicalTerminal, getMessagePriority, getMtId, getReceiver, getSender, getSequence, getSequence, getSequence, getSequenceList, getSequenceList, getSequenceNumber, getServiceId, getSessionNumber, getSwiftMessage, getSwiftMessageNotNullOrException, getVariant, isIncoming, isInput, isOutgoing, isOutput, isType, json, message, nameFromClass, read, setReceiver, setReceiver, setSender, setSender, setSwiftMessage, tag, tags, 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
  - MT581
```
public MT581(SwiftMessage m)
```
    Creates an MT581 initialized with the parameter SwiftMessage
    
    Parameters:
    
    m - swift message with the MT581 content
  - MT581
```
public MT581(MtSwiftMessage m)
```
    Creates an MT581 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT581 content, the parameter can not be null
    
    See Also:
    
    MT581(String)
  - MT581
```
public MT581()
```
    Creates and initializes a new MT581 input message setting TEST BICS as sender and receiver.
    All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT581
```
public MT581(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT581 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
  - MT581
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MT581(int messageType,
                                                           java.lang.String sender,
                                                           java.lang.String receiver)
```
    Deprecated. Use instead new MT581(sender, receiver) instead
    
    DO NOT USE THIS METHOD It is kept for compatibility but will be removed very soon, since the messageType parameter is actually ignored.
    
    See Also:
    
    MT581(String, String)
  - MT581
```
public MT581(java.lang.String fin)
```
    Creates a new MT581 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
  - MT581
```
public MT581(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT581 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
    
    Since:
    
    7.7
  - MT581
```
public MT581(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT581 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
    
    Since:
    
    7.7
- Method Detail
  - parse
```
public static MT581 parse(MtSwiftMessage m)
```
    Creates an MT581 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT581 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT581(String)
  - parse
```
public static MT581 parse(java.lang.String fin)
```
    Creates a new MT581 by parsing a String with the message content in its swift FIN format.
    If the fin parameter cannot be parsed, the returned MT581 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 MT581 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT581 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT581 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 MT581 or null if stream is null or the message cannot be parsed
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    7.7
  - parse
```
public static MT581 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT581 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 MT581 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
    
    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 MT581 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 MT581 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 MT581 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
  - 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 MT581 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 MT581 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)
  - getField23
```
public Field23 getField23()
```
    Iterates through block4 fields and return the first one whose name matches 23, or null if none is found.
    The first occurrence of field 23 at MT581 is expected to be the only one.
    
    Returns:
    
    a Field23 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 MT581 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)
  - getField35H
```
public Field35H getField35H()
```
    Iterates through block4 fields and return the first one whose name matches 35H, or null if none is found.
    The first occurrence of field 35H at MT581 is expected to be the only one.
    
    Returns:
    
    a Field35H object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField35B
```
public Field35B getField35B()
```
    Iterates through block4 fields and return the first one whose name matches 35B, or null if none is found.
    The first occurrence of field 35B at MT581 is expected to be the only one.
    
    Returns:
    
    a Field35B object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField80C
```
public Field80C getField80C()
```
    Iterates through block4 fields and return the first one whose name matches 80C, or null if none is found.
    The first occurrence of field 80C at MT581 is expected to be the only one.
    
    Returns:
    
    a Field80C object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField34B
```
public Field34B getField34B()
```
    Iterates through block4 fields and return the first one whose name matches 34B, or null if none is found.
    The first occurrence of field 34B at MT581 is expected to be the only one.
    
    Returns:
    
    a Field34B object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField72
```
public Field72 getField72()
```
    Iterates through block4 fields and return the first one whose name matches 72, or null if none is found.
    The first occurrence of field 72 at MT581 is expected to be the only one.
    
    Returns:
    
    a Field72 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 MT581

MT 581 -

SWIFT MT581 (ISO 15022) message structure:

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

MT581

MT581

MT581

MT581

MT581

MT581

MT581

MT581

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

getField20

getField21

getField23

getField30

getField35H

getField35B

getField80C

getField34B

getField72