com.prowidesoftware.swift.model.mt.mt0xx

Class MT068

java.lang.Object

com.prowidesoftware.swift.model.AbstractMessage

com.prowidesoftware.swift.model.mt.AbstractMT

com.prowidesoftware.swift.model.mt.mt0xx.MT068

All Implemented Interfaces:

java.io.Serializable

@Generated
public class MT068
extends AbstractMT
implements java.io.Serializable

MT 068 - Undelivered Report Rules

SWIFT MT068 (ISO 15022) message structure:

• Field 302 (M)
• Field 341 (M)
• Field 301 (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	N Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsN.N
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.
static java.lang.String	Y Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsY.Y

Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

m

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MT068	append(Field... fields) Add all the fields to the end of the block4.
MT068	append(SwiftTagListBlock block) Add all tags from block to the end of the block4.
MT068	append(Tag... tags) Add all tags to the end of the block4.
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 MT068 is expected to be the only one.
Field302	getField302() Iterates through block4 fields and return the first one whose name matches 302, or null if none is found. The first occurrence of field 302 at MT068 is expected to be the only one.
Field341	getField341() Iterates through block4 fields and return the first one whose name matches 341, or null if none is found. The first occurrence of field 341 at MT068 is expected to be the only one.
java.lang.String	getMessageType() Returns this MT number
static MT068	parse(java.io.File file) Creates a new MT068 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 MT068	parse(java.io.InputStream stream) Creates a new MT068 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 MT068	parse(MtSwiftMessage m) Creates an MT068 initialized with the parameter MtSwiftMessage.
static MT068	parse(java.lang.String fin) Creates a new MT068 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT068 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

N

@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String N

Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsN.N

Constant for qualifier with value N

See Also:

SchemeConstantsN.N, Constant Field Values

Y

@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String Y

Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsY.Y

Constant for qualifier with value Y

See Also:

SchemeConstantsY.Y, Constant Field Values

Constructor Detail

MT068

public MT068(SwiftMessage m)

Creates an MT068 initialized with the parameter SwiftMessage

Parameters:

m - swift message with the MT068 content

MT068

public MT068(MtSwiftMessage m)

Creates an MT068 initialized with the parameter MtSwiftMessage.

Parameters:

m - swift message with the MT068 content, the parameter can not be null

See Also:

MT068(String)

MT068

public MT068()

Creates and initializes a new MT068 input message setting TEST BICS as sender and receiver.
All mandatory header attributes are completed with default values.

Since:

7.6

MT068

public MT068(java.lang.String sender,
             java.lang.String receiver)

Creates and initializes a new MT068 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

MT068

@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MT068(int messageType,
                                                           java.lang.String sender,
                                                           java.lang.String receiver)

Deprecated. Use instead new MT068(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:

MT068(String, String)

MT068

public MT068(java.lang.String fin)

Creates a new MT068 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

MT068

public MT068(java.io.InputStream stream)
      throws java.io.IOException

Creates a new MT068 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

MT068

public MT068(java.io.File file)
      throws java.io.IOException

Creates a new MT068 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 MT068 parse(MtSwiftMessage m)

Creates an MT068 initialized with the parameter MtSwiftMessage.

Parameters:

m - swift message with the MT068 content

Returns:

the created object or null if the parameter is null

Since:

7.7

See Also:

MT068(String)

parse

public static MT068 parse(java.lang.String fin)

Creates a new MT068 by parsing a String with the message content in its swift FIN format.
If the fin parameter cannot be parsed, the returned MT068 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 MT068 or null if fin is null

Since:

7.7

parse

public static MT068 parse(java.io.InputStream stream)
                   throws java.io.IOException

Creates a new MT068 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 MT068 or null if stream is null or the message cannot be parsed

Throws:

java.io.IOException

Since:

7.7

parse

public static MT068 parse(java.io.File file)
                   throws java.io.IOException

Creates a new MT068 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 MT068 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 MT068 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 MT068 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 MT068 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

getField302

public Field302 getField302()

Iterates through block4 fields and return the first one whose name matches 302, or null if none is found.
The first occurrence of field 302 at MT068 is expected to be the only one.

Returns:

a Field302 object or null if the field is not found

Throws:

java.lang.IllegalStateException - if SwiftMessage object is not initialized

See Also:

SwiftTagListBlock.getTagByName(String)

getField341

public Field341 getField341()

Iterates through block4 fields and return the first one whose name matches 341, or null if none is found.
The first occurrence of field 341 at MT068 is expected to be the only one.

Returns:

a Field341 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 MT068 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)