MT801 (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt8xx.MT801

All Implemented Interfaces:

JsonSerializable, java.io.Serializable
```
@Generated
public class MT801
extends AbstractMT
implements java.io.Serializable
```
MT 801 - T/C Multiple Sales Advice.
SWIFT MT801 (ISO 15022) message structure:
- Field 20 (M)
- Field 28 (M)
- Sequence Loop1 (M) (repetitive)
  - Field 51 A,C (M)
  - Sequence Loop2 (M) (repetitive)
    Field 23 (M)
    
    Field 30 (O)
    
    Field 26 A (M) (repetitive)
    
    Field 33 B (M)
    
    Field 73 (O)
  - Field 34 B (M)
  - Field 16 A (M)
This source code is specific to release SRU 2023
For additional resources check https://www.prowidesoftware.com/resources
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MT801.Loop1` Class to model Sequence "Loop1" in MT 801.
`static class`	`MT801.Loop2` Class to model Sequence "Loop2" in MT 801.

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
`MT801()` Creates and initializes a new MT801 input message setting TEST BICS as sender and receiver.
`MT801(java.io.File file)` Creates a new MT801 by parsing a file with the message content in its swift FIN format.
`MT801(java.io.InputStream stream)` Creates a new MT801 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`MT801(MtSwiftMessage m)` Creates an MT801 initialized with the parameter MtSwiftMessage.
`MT801(java.lang.String fin)` Creates a new MT801 by parsing a String with the message content in its swift FIN format.
`MT801(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT801 input message from sender to receiver.
`MT801(SwiftMessage m)` Creates an MT801 initialized with the parameter SwiftMessage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT801`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT801`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT801`	`append(Tag... tags)` Add all tags to the end of the block4.
`static MT801`	`fromJson(java.lang.String json)` Creates an MT801 messages from its JSON representation.
`java.util.List<Field16A>`	`getField16A()` Iterates through block4 fields and return all occurrences of fields whose names matches 16A, or `Collections.emptyList()` if none is found.
`Field20`	`getField20()` Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.
`java.util.List<Field23>`	`getField23()` Iterates through block4 fields and return all occurrences of fields whose names matches 23, or `Collections.emptyList()` if none is found.
`java.util.List<Field26A>`	`getField26A()` Iterates through block4 fields and return all occurrences of fields whose names matches 26A, or `Collections.emptyList()` if none is found.
`Field28`	`getField28()` Iterates through block4 fields and return the first one whose name matches 28, or null if none is found.
`java.util.List<Field30>`	`getField30()` Iterates through block4 fields and return all occurrences of fields whose names matches 30, or `Collections.emptyList()` if none is found.
`java.util.List<Field33B>`	`getField33B()` Iterates through block4 fields and return all occurrences of fields whose names matches 33B, or `Collections.emptyList()` if none is found.
`java.util.List<Field34B>`	`getField34B()` Iterates through block4 fields and return all occurrences of fields whose names matches 34B, or `Collections.emptyList()` if none is found.
`java.util.List<Field51A>`	`getField51A()` Iterates through block4 fields and return all occurrences of fields whose names matches 51A, or `Collections.emptyList()` if none is found.
`java.util.List<Field51C>`	`getField51C()` Iterates through block4 fields and return all occurrences of fields whose names matches 51C, or `Collections.emptyList()` if none is found.
`java.util.List<Field73>`	`getField73()` Iterates through block4 fields and return all occurrences of fields whose names matches 73, or `Collections.emptyList()` if none is found.
`java.util.List<MT801.Loop1>`	`getLoop1List()` Get the list of Loop1 delimited by leading tag and end, with an optional tail.
`static java.util.List<MT801.Loop1>`	`getLoop1List(SwiftTagListBlock parentSequence)` Get the list of Loop1 delimited by leading tag and end, with an optional tail.
`java.util.List<MT801.Loop2>`	`getLoop2List()` Get the list of Loop2 delimited by leading tag and end, with an optional tail.
`static java.util.List<MT801.Loop2>`	`getLoop2List(SwiftTagListBlock parentSequence)` Get the list of Loop2 delimited by leading tag and end, with an optional tail.
`java.lang.String`	`getMessageType()` Returns this MT number.
`static MT801`	`parse(java.io.File file)` Creates a new MT801 by parsing a file with the message content in its swift FIN format.
`static MT801`	`parse(java.io.InputStream stream)` Creates a new MT801 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`static MT801`	`parse(MtSwiftMessage m)` Creates an MT801 initialized with the parameter MtSwiftMessage.
`static MT801`	`parse(java.lang.String fin)` Creates a new MT801 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
  - MT801
```
public MT801(SwiftMessage m)
```
    Creates an MT801 initialized with the parameter SwiftMessage.
    
    Parameters:
    
    m - swift message with the MT801 content
  - MT801
```
public MT801(MtSwiftMessage m)
```
    Creates an MT801 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT801 content, the parameter can not be null
    
    See Also:
    
    MT801(String)
  - MT801
```
public MT801()
```
    Creates and initializes a new MT801 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT801
```
public MT801(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT801 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
  - MT801
```
public MT801(java.lang.String fin)
```
    Creates a new MT801 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
  - MT801
```
public MT801(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT801 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
  - MT801
```
public MT801(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT801 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 MT801 parse(MtSwiftMessage m)
```
    Creates an MT801 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT801 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT801(String)
  - parse
```
public static MT801 parse(java.lang.String fin)
```
    Creates a new MT801 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT801 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 MT801 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT801 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT801 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 MT801 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 MT801 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT801 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 MT801 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 MT801 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 MT801 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 MT801 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 MT801 fromJson(java.lang.String json)
```
    Creates an MT801 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 MT801 message
    
    Returns:
    
    a new instance of MT801
    
    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 MT801 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)
  - getField28
```
public Field28 getField28()
```
    Iterates through block4 fields and return the first one whose name matches 28, or null if none is found. The first occurrence of field 28 at MT801 is expected to be the only one.
    
    Returns:
    
    a Field28 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField51A
```
public java.util.List<Field51A> getField51A()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 51A, or Collections.emptyList() if none is found. Multiple occurrences of field 51A at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field51A objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField51C
```
public java.util.List<Field51C> getField51C()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 51C, or Collections.emptyList() if none is found. Multiple occurrences of field 51C at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field51C objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField23
```
public java.util.List<Field23> getField23()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 23, or Collections.emptyList() if none is found. Multiple occurrences of field 23 at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field23 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField30
```
public java.util.List<Field30> getField30()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 30, or Collections.emptyList() if none is found. Multiple occurrences of field 30 at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field30 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField26A
```
public java.util.List<Field26A> getField26A()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 26A, or Collections.emptyList() if none is found. Multiple occurrences of field 26A at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field26A objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField33B
```
public java.util.List<Field33B> getField33B()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 33B, or Collections.emptyList() if none is found. Multiple occurrences of field 33B at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field33B objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField73
```
public java.util.List<Field73> getField73()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 73, or Collections.emptyList() if none is found. Multiple occurrences of field 73 at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field73 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField34B
```
public java.util.List<Field34B> getField34B()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 34B, or Collections.emptyList() if none is found. Multiple occurrences of field 34B at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field34B objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField16A
```
public java.util.List<Field16A> getField16A()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 16A, or Collections.emptyList() if none is found. Multiple occurrences of field 16A at MT801 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field16A objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getLoop1List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public java.util.List<MT801.Loop1> getLoop1List()
```
    Get the list of Loop1 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
    
    Returns:
    
    the found sequences or an empty list if none is found
    
    See Also:
    
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
  - getLoop1List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static java.util.List<MT801.Loop1> getLoop1List(SwiftTagListBlock parentSequence)
```
    Get the list of Loop1 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
    
    Parameters:
    
    parentSequence - a not null parent sequence to find Loop1 within it
    
    Returns:
    
    the found sequences or an empty list if none is found or parent sequence is null
    
    Since:
    
    7.7
    
    See Also:
    
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
  - getLoop2List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public java.util.List<MT801.Loop2> getLoop2List()
```
    Get the list of Loop2 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
    
    Returns:
    
    the found sequences or an empty list if none is found
    
    See Also:
    
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
  - getLoop2List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static java.util.List<MT801.Loop2> getLoop2List(SwiftTagListBlock parentSequence)
```
    Get the list of Loop2 delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur more than once according to the Standard. If message is empty or no sequences are found an empty list is returned.
    
    Parameters:
    
    parentSequence - a not null parent sequence to find Loop2 within it
    
    Returns:
    
    the found sequences or an empty list if none is found or parent sequence is null
    
    Since:
    
    7.7
    
    See Also:
    
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])

Class MT801

Nested Class Summary

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

MT801

MT801

MT801

MT801

MT801

MT801

MT801

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

fromJson

getField20

getField28

getField51A

getField51C

getField23

getField30

getField26A

getField33B

getField73

getField34B

getField16A

getLoop1List

getLoop1List

getLoop2List

getLoop2List