com.prowidesoftware.swift.model.mt.mt0xx.MT020 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.mt0xx;
import com.prowidesoftware.Generated;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
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 020 - Retrieval Request.
*
*
* SWIFT MT020 (ISO 15022) message structure:
*
- Field 102 (M)
-
Sequence _A - GPA or FIN choices (O)
-
Sequence _A1 - MIR (O)
- Field 251 (M)
-
Sequence _A2 - MIR range (O)
- Field 252 (M)
-
Sequence _A3 - MOR (O)
- Field 253 (M)
-
Sequence _A4 - MOR range (O)
- Field 254 (M)
-
Sequence _A5 - Message input type (O)
- Field 255 (M)
- Field 152 (O)
-
Sequence _A6 - Input time range (O)
- Field 257 (M)
- Field 152 (O)
-
Sequence _A7 - Message output type (O)
- Field 258 (M)
- Field 153 (O)
-
Sequence _A8 - Output time range (O)
- Field 260 (M)
- Field 153 (O)
-
Sequence _A9 - Category input type (O)
- Field 256 (M)
- Field 152 (O)
-
Sequence _A10 - Category output type (O)
- Field 259 (M)
- Field 153 (O)
-
Sequence _A11 - MUR input (O)
- Field 263 (M)
- Field 108 (M)
- Field 152 (O)
-
Sequence _A12 - MUR output (O)
- Field 264 (M)
- Field 108 (M)
- Field 153 (O)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT020 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(MT020.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "020";
/**
* Creates an MT020 initialized with the parameter SwiftMessage.
* @param m swift message with the MT020 content
*/
public MT020(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT020 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT020 content, the parameter can not be null
* @see #MT020(String)
*/
public MT020(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT020 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT020 content
* @return the created object or null if the parameter is null
* @see #MT020(String)
* @since 7.7
*/
public static MT020 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT020(m);
}
/**
* Creates and initializes a new MT020 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT020() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT020 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 MT020(final String sender, final String receiver) {
super(20, sender, receiver);
}
/**
* Creates a new MT020 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 MT020(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 MT020 object from FIN content with a Service Message. Check if the MT020 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "020")) {
log.warning("Creating an MT020 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT020 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT020 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 MT020 or null if fin is null
* @since 7.7
*/
public static MT020 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT020(fin);
}
/**
* Creates a new MT020 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 MT020(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT020 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 MT020 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 MT020 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT020(stream);
}
/**
* Creates a new MT020 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 MT020(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT020 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 MT020 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 MT020 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT020(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "020";
}
/**
* 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 MT020 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 MT020 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 MT020 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT020 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 MT020 message
* @return a new instance of MT020
* @since 7.10.3
*/
public static MT020 fromJson(final String json) {
return (MT020) AbstractMT.fromJson(json);
}
/**
* Iterates through block4 fields and return the first one whose name matches 102,
* or null if none is found.
* The first occurrence of field 102 at MT020 is expected to be the only one.
*
* @return a Field102 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field102 getField102() {
final Tag t = tag("102");
if (t != null) {
return new Field102(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 251,
* or null if none is found.
* The first occurrence of field 251 at MT020 is expected to be the only one.
*
* @return a Field251 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field251 getField251() {
final Tag t = tag("251");
if (t != null) {
return new Field251(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 252,
* or null if none is found.
* The first occurrence of field 252 at MT020 is expected to be the only one.
*
* @return a Field252 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field252 getField252() {
final Tag t = tag("252");
if (t != null) {
return new Field252(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 253,
* or null if none is found.
* The first occurrence of field 253 at MT020 is expected to be the only one.
*
* @return a Field253 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field253 getField253() {
final Tag t = tag("253");
if (t != null) {
return new Field253(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 254,
* or null if none is found.
* The first occurrence of field 254 at MT020 is expected to be the only one.
*
* @return a Field254 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field254 getField254() {
final Tag t = tag("254");
if (t != null) {
return new Field254(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 255,
* or null if none is found.
* The first occurrence of field 255 at MT020 is expected to be the only one.
*
* @return a Field255 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field255 getField255() {
final Tag t = tag("255");
if (t != null) {
return new Field255(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 257,
* or null if none is found.
* The first occurrence of field 257 at MT020 is expected to be the only one.
*
* @return a Field257 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field257 getField257() {
final Tag t = tag("257");
if (t != null) {
return new Field257(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 258,
* or null if none is found.
* The first occurrence of field 258 at MT020 is expected to be the only one.
*
* @return a Field258 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field258 getField258() {
final Tag t = tag("258");
if (t != null) {
return new Field258(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 260,
* or null if none is found.
* The first occurrence of field 260 at MT020 is expected to be the only one.
*
* @return a Field260 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field260 getField260() {
final Tag t = tag("260");
if (t != null) {
return new Field260(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 256,
* or null if none is found.
* The first occurrence of field 256 at MT020 is expected to be the only one.
*
* @return a Field256 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field256 getField256() {
final Tag t = tag("256");
if (t != null) {
return new Field256(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 259,
* or null if none is found.
* The first occurrence of field 259 at MT020 is expected to be the only one.
*
* @return a Field259 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field259 getField259() {
final Tag t = tag("259");
if (t != null) {
return new Field259(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 263,
* or null if none is found.
* The first occurrence of field 263 at MT020 is expected to be the only one.
*
* @return a Field263 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field263 getField263() {
final Tag t = tag("263");
if (t != null) {
return new Field263(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 264,
* or null if none is found.
* The first occurrence of field 264 at MT020 is expected to be the only one.
*
* @return a Field264 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field264 getField264() {
final Tag t = tag("264");
if (t != null) {
return new Field264(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 152,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 152 at MT020 are expected at one sequence or across several sequences.
*
* @return a List of Field152 objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField152() {
final List result = new ArrayList<>();
final Tag[] tags = tags("152");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field152(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 153,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 153 at MT020 are expected at one sequence or across several sequences.
*
* @return a List of Field153 objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField153() {
final List result = new ArrayList<>();
final Tag[] tags = tags("153");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field153(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 108,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 108 at MT020 are expected at one sequence or across several sequences.
*
* @return a List of Field108 objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField108() {
final List result = new ArrayList<>();
final Tag[] tags = tags("108");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field108(tag.getValue()));
}
}
return result;
}
}