com.prowidesoftware.swift.model.mt.mt7xx.MT740 Maven / Gradle / Ivy
Show all versions of pw-swift-core Show documentation
/*
* Copyright 2006-2023 Prowide
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.prowidesoftware.swift.model.mt.mt7xx;
import com.prowidesoftware.Generated;
import java.io.Serializable;
import org.apache.commons.lang3.StringUtils;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.model.field.*;
import com.prowidesoftware.swift.model.mt.AbstractMT;
import com.prowidesoftware.swift.utils.Lib;
import java.io.File;
import java.io.InputStream;
import java.io.IOException;
/**
* MT 740 - Authorisation to Reimburse.
*
*
* SWIFT MT740 (ISO 15022) message structure:
*
- Field 20 (M)
- Field 25 (O)
- Field 40 F (M)
- Field 31 D (O)
- Field 58 A,D (O)
- Field 59 (O)
- Field 32 B (M)
- Field 39 A (O)
- Field 39 C (O)
- Field 41 A,D (M)
- Field 42 C (O)
- Field 42 A,D (O)
- Field 42 M (O)
- Field 42 P (O)
- Field 71 A (O)
- Field 71 D (O)
- Field 72 Z (O)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT740 extends AbstractMT implements Serializable {
/**
* Constant identifying the SRU to which this class belongs to.
*/
public static final int SRU = 2023;
private static final long serialVersionUID = 1L;
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(MT740.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "740";
/**
* Creates an MT740 initialized with the parameter SwiftMessage.
* @param m swift message with the MT740 content
*/
public MT740(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT740 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT740 content, the parameter can not be null
* @see #MT740(String)
*/
public MT740(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT740 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT740 content
* @return the created object or null if the parameter is null
* @see #MT740(String)
* @since 7.7
*/
public static MT740 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT740(m);
}
/**
* Creates and initializes a new MT740 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT740() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT740 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,
*
* @param sender the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @param receiver the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @since 7.7
*/
public MT740(final String sender, final String receiver) {
super(740, sender, receiver);
}
/**
* Creates a new MT740 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.
*
* @param fin a string with the MT message in its FIN swift format
* @since 7.7
*/
public MT740(final String fin) {
super();
if (fin != null) {
final SwiftMessage parsed = read(fin);
if (parsed != null) {
super.m = parsed;
sanityCheck(parsed);
}
}
}
private void sanityCheck(final SwiftMessage param) {
if (param.isServiceMessage()) {
log.warning("Creating an MT740 object from FIN content with a Service Message. Check if the MT740 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "740")) {
log.warning("Creating an MT740 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT740 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT740 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.
*
* @param fin a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
* @return a new instance of MT740 or null if fin is null
* @since 7.7
*/
public static MT740 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT740(fin);
}
/**
* Creates a new MT740 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.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public MT740(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT740 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.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @return a new instance of MT740 or null if stream is null or the message cannot be parsed
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public static MT740 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT740(stream);
}
/**
* Creates a new MT740 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.
*
* @param file a file with the MT message in its FIN swift format.
* @throws IOException if the file content cannot be read
* @since 7.7
*/
public MT740(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT740 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.
*
* @param file a file with the MT message in its FIN swift format.
* @return a new instance of MT740 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 if the file content cannot be read
* @since 7.7
*/
public static MT740 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT740(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "740";
}
/**
* Add all tags from block to the end of the block4.
*
* @param block to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT740 append(final SwiftTagListBlock block) {
super.append(block);
return this;
}
/**
* Add all tags to the end of the block4.
*
* @param tags to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT740 append(final Tag... tags) {
super.append(tags);
return this;
}
/**
* Add all the fields to the end of the block4.
*
* @param fields to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT740 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT740 messages from its JSON representation.
*
* For generic conversion of JSON into the corresponding MT instance
* see {@link AbstractMT#fromJson(String)}
*
* @param json a JSON representation of an MT740 message
* @return a new instance of MT740
* @since 7.10.3
*/
public static MT740 fromJson(final String json) {
return (MT740) AbstractMT.fromJson(json);
}
/**
* 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 MT740 is expected to be the only one.
*
* @return a Field20 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field20 getField20() {
final Tag t = tag("20");
if (t != null) {
return new Field20(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 25,
* or null if none is found.
* The first occurrence of field 25 at MT740 is expected to be the only one.
*
* @return a Field25 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field25 getField25() {
final Tag t = tag("25");
if (t != null) {
return new Field25(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 40F,
* or null if none is found.
* The first occurrence of field 40F at MT740 is expected to be the only one.
*
* @return a Field40F object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field40F getField40F() {
final Tag t = tag("40F");
if (t != null) {
return new Field40F(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 31D,
* or null if none is found.
* The first occurrence of field 31D at MT740 is expected to be the only one.
*
* @return a Field31D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field31D getField31D() {
final Tag t = tag("31D");
if (t != null) {
return new Field31D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 58A,
* or null if none is found.
* The first occurrence of field 58A at MT740 is expected to be the only one.
*
* @return a Field58A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field58A getField58A() {
final Tag t = tag("58A");
if (t != null) {
return new Field58A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 58D,
* or null if none is found.
* The first occurrence of field 58D at MT740 is expected to be the only one.
*
* @return a Field58D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field58D getField58D() {
final Tag t = tag("58D");
if (t != null) {
return new Field58D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 59,
* or null if none is found.
* The first occurrence of field 59 at MT740 is expected to be the only one.
*
* @return a Field59 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field59 getField59() {
final Tag t = tag("59");
if (t != null) {
return new Field59(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 32B,
* or null if none is found.
* The first occurrence of field 32B at MT740 is expected to be the only one.
*
* @return a Field32B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field32B getField32B() {
final Tag t = tag("32B");
if (t != null) {
return new Field32B(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 39A,
* or null if none is found.
* The first occurrence of field 39A at MT740 is expected to be the only one.
*
* @return a Field39A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field39A getField39A() {
final Tag t = tag("39A");
if (t != null) {
return new Field39A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 39C,
* or null if none is found.
* The first occurrence of field 39C at MT740 is expected to be the only one.
*
* @return a Field39C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field39C getField39C() {
final Tag t = tag("39C");
if (t != null) {
return new Field39C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 41A,
* or null if none is found.
* The first occurrence of field 41A at MT740 is expected to be the only one.
*
* @return a Field41A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field41A getField41A() {
final Tag t = tag("41A");
if (t != null) {
return new Field41A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 41D,
* or null if none is found.
* The first occurrence of field 41D at MT740 is expected to be the only one.
*
* @return a Field41D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field41D getField41D() {
final Tag t = tag("41D");
if (t != null) {
return new Field41D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 42C,
* or null if none is found.
* The first occurrence of field 42C at MT740 is expected to be the only one.
*
* @return a Field42C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field42C getField42C() {
final Tag t = tag("42C");
if (t != null) {
return new Field42C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 42A,
* or null if none is found.
* The first occurrence of field 42A at MT740 is expected to be the only one.
*
* @return a Field42A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field42A getField42A() {
final Tag t = tag("42A");
if (t != null) {
return new Field42A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 42D,
* or null if none is found.
* The first occurrence of field 42D at MT740 is expected to be the only one.
*
* @return a Field42D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field42D getField42D() {
final Tag t = tag("42D");
if (t != null) {
return new Field42D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 42M,
* or null if none is found.
* The first occurrence of field 42M at MT740 is expected to be the only one.
*
* @return a Field42M object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field42M getField42M() {
final Tag t = tag("42M");
if (t != null) {
return new Field42M(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 42P,
* or null if none is found.
* The first occurrence of field 42P at MT740 is expected to be the only one.
*
* @return a Field42P object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field42P getField42P() {
final Tag t = tag("42P");
if (t != null) {
return new Field42P(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 71A,
* or null if none is found.
* The first occurrence of field 71A at MT740 is expected to be the only one.
*
* @return a Field71A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field71A getField71A() {
final Tag t = tag("71A");
if (t != null) {
return new Field71A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 71D,
* or null if none is found.
* The first occurrence of field 71D at MT740 is expected to be the only one.
*
* @return a Field71D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field71D getField71D() {
final Tag t = tag("71D");
if (t != null) {
return new Field71D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 72Z,
* or null if none is found.
* The first occurrence of field 72Z at MT740 is expected to be the only one.
*
* @return a Field72Z object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field72Z getField72Z() {
final Tag t = tag("72Z");
if (t != null) {
return new Field72Z(t.getValue());
} else {
return null;
}
}
}