java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt9xx.MT973

All Implemented Interfaces:: Serializable

@Generated
public class MT973
extends AbstractMT
implements Serializable

MT 973
Netting Request Message

MT973 Format

 
Main Sequence main

Field 20
Letter options: null

Sequence 

Field 12
Letter options: null
Field 25
Letter options: null

This source code is specific to release SRU 2016

Author:: www.prowidesoftware.com
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MT973.Sequence_0
Class for Sequence "_0" of MT 973

Nested Classes
Modifier and Type	Class and Description
`static class`	`MT973.Sequence_0` Class for Sequence "_0" of MT 973

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`_971` Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._971
`static String`	`_972` Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._972
`static String`	`_998` Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._998
`static 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
`MT973()` Creates and initializes a new MT973 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
`MT973(File file)` Creates a new MT973 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.
`MT973(InputStream stream)` Creates a new MT973 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.
`MT973(int messageType, String sender, String receiver)` Deprecated.
`MT973(MtSwiftMessage m)` Creates an MT973 initialized with the parameter MtSwiftMessage.
`MT973(String fin)` Creates a new MT973 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.
`MT973(String sender, String receiver)` Creates and initializes a new MT973 input message from sender to receiver. All mandatory header attributes are completed with default values.
`MT973(SwiftMessage m)` Creates an MT973 initialized with the parameter SwiftMessage

Method Summary

Methods
Modifier and Type	Method and Description
`MT973`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT973`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT973`	`append(Tag... tags)` Add all tags to the end of the block4.
`List<Field12>`	`getField12()` Iterates through block4 fields and return all occurrences of fields whose names matches 12, or `Collections.emptyList()` if none is found. Multiple occurrences of field 12 at MT973 are expected at one sequence or across several sequences.
`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 MT973 is expected to be the only one.
`List<Field25>`	`getField25()` Iterates through block4 fields and return all occurrences of fields whose names matches 25, or `Collections.emptyList()` if none is found. Multiple occurrences of field 25 at MT973 are expected at one sequence or across several sequences.
`String`	`getMessageType()` Returns this MT number
`List<MT973.Sequence_0>`	`getSequence_0List()` Get the list of Sequence_0 delimited by leading tag and end, with an optional tail.
`static List<MT973.Sequence_0>`	`getSequence_0List(SwiftTagListBlock parentSequence)` Get the list of Sequence_0 delimited by leading tag and end, with an optional tail.
`static MT973`	`parse(File file)` Creates a new MT973 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 MT973`	`parse(InputStream stream)` Creates a new MT973 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 MT973`	`parse(MtSwiftMessage m)` Creates an MT973 initialized with the parameter MtSwiftMessage.
`static MT973`	`parse(String fin)` Creates a new MT973 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT973 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, 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 String NAME
```
    Constant for MT name, this is part of the classname, after MT
    
    See Also:
    Constant Field Values
  - _971
```
@Deprecated
@ProwideDeprecated(phase2=_2017)
public static final String _971
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._971
    
    Constant for qualifier with value 971
    
    See Also:
    SchemeConstants_9._971, Constant Field Values
  - _972
```
@Deprecated
@ProwideDeprecated(phase2=_2017)
public static final String _972
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._972
    
    Constant for qualifier with value 972
    
    See Also:
    SchemeConstants_9._972, Constant Field Values
  - _998
```
@Deprecated
@ProwideDeprecated(phase2=_2017)
public static final String _998
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstants_9._998
    
    Constant for qualifier with value 998
    
    See Also:
    SchemeConstants_9._998, Constant Field Values
- Constructor Detail
  - MT973
```
public MT973(SwiftMessage m)
```
    Creates an MT973 initialized with the parameter SwiftMessage
    
    Parameters:
    m - swift message with the MT973 content
  - MT973
```
public MT973(MtSwiftMessage m)
```
    Creates an MT973 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    m - swift message with the MT973 content, the parameter can not be null
    See Also:
    MT973(String)
  - MT973
```
public MT973()
```
    Creates and initializes a new MT973 input message setting TEST BICS as sender and receiver.
    All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT973
```
public MT973(String sender,
     String receiver)
```
    Creates and initializes a new MT973 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
  - MT973
```
@Deprecated
public MT973(int messageType,
                String sender,
                String receiver)
```
    Deprecated.
    
    DO NOT USE THIS METHOD It is kept for compatibility but will be removed very soon, since the messageType parameter is actually ignored. Use instead new MT973(sender, receiver)
    
    See Also:
    MT973(String, String)
  - MT973
```
public MT973(String fin)
```
    Creates a new MT973 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
  - MT973
```
public MT973(InputStream stream)
      throws IOException
```
    Creates a new MT973 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:
    
    IOException
    Since:
    
    7.7
  - MT973
```
public MT973(File file)
      throws IOException
```
    Creates a new MT973 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:
    
    IOException
    Since:
    
    7.7
- Method Detail
  - parse
```
public static MT973 parse(MtSwiftMessage m)
```
    Creates an MT973 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    m - swift message with the MT973 content
    
    Returns:
    the created object or null if the parameter is null
    Since:
    
    7.7
    
    See Also:
    MT973(String)
  - parse
```
public static MT973 parse(String fin)
```
    Creates a new MT973 by parsing a String with the message content in its swift FIN format.
    If the fin parameter cannot be parsed, the returned MT973 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 MT973 or null if fin is null
    Since:
    
    7.7
  - parse
```
public static MT973 parse(InputStream stream)
                   throws IOException
```
    Creates a new MT973 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 MT973 or null if stream is null or the message cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.7
  - parse
```
public static MT973 parse(File file)
                   throws IOException
```
    Creates a new MT973 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 MT973 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.7
  - getMessageType
```
public 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 MT973 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 MT973 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 MT973 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 MT973 is expected to be the only one.
    
    Returns:
    a Field20 object or null if the field is not found
    
    Throws:
    
    IllegalStateException - if SwiftMessage object is not initialized
    See Also:
    SwiftTagListBlock.getTagByName(String)
  - getField12
```
public List<Field12> getField12()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 12, or Collections.emptyList() if none is found.
    Multiple occurrences of field 12 at MT973 are expected at one sequence or across several sequences.
    
    Returns:
    a List of Field12 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    IllegalStateException - if SwiftMessage object is not initialized
    See Also:
    SwiftTagListBlock.getTagsByName(String)
  - getField25
```
public List<Field25> getField25()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 25, or Collections.emptyList() if none is found.
    Multiple occurrences of field 25 at MT973 are expected at one sequence or across several sequences.
    
    Returns:
    a List of Field25 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    IllegalStateException - if SwiftMessage object is not initialized
    See Also:
    SwiftTagListBlock.getTagsByName(String)
  - getSequence_0List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public List<MT973.Sequence_0> getSequence_0List()
```
    Get the list of Sequence_0 delimited by leading tag and end, with an optional tail. The presence of this methods indicates that this sequence can occur more than once according to the Standard. If message is empty or nor sequences are found an empty list is returned.
    
    See Also:
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
  - getSequence_0List
```
@SequenceStyle(value=GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static List<MT973.Sequence_0> getSequence_0List(SwiftTagListBlock parentSequence)
```
    Get the list of Sequence_0 delimited by leading tag and end, with an optional tail. The presence of this methods indicates that this sequence can occur more than once according to the Standard. If message is empty or nor sequences are found an empty list is returned.
    
    Parameters:
    parentSequence - an optional parent sequence or null to find Sequence_0 within the complete message
    Since:
    
    7.7
    
    See Also:
    SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])

Class MT973

MT973 Format

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

_971

_972

_998

Constructor Detail

MT973

MT973

MT973

MT973

MT973

MT973

MT973

MT973

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

getField20

getField12

getField25

getSequence_0List

getSequence_0List