Class MT526
- java.lang.Object
-
- com.prowidesoftware.swift.model.AbstractMessage
-
- com.prowidesoftware.swift.model.mt.AbstractMT
-
- com.prowidesoftware.swift.model.mt.mt5xx.MT526
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
@Generated public class MT526 extends AbstractMT implements java.io.Serializable
MT 526 - General Securities Lending/Borrowing Message.SWIFT MT526 (ISO 15022) message structure:
-
Sequence A (M)
- Field 20 (M)
- Field 21 (O)
- Field 23 (M)
- Field 83 C (O)
- Field 29 A (O)
- Field 29 B (O)
-
Sequence B (M) (repetitive)
- Field 35 B (M)
- Field 35 A (O)
- Field 30 (O)
- Field 31 F (O)
- Field 87 A,D (O)
- Field 72 (O)
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 Description static class
MT526.SequenceA
Class to model Sequence "A" in MT 526.static class
MT526.SequenceB
Class to model Sequence "B" in MT 526.
-
Field Summary
Fields Modifier and Type Field 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 Description MT526()
Creates and initializes a new MT526 input message setting TEST BICS as sender and receiver.MT526(MtSwiftMessage m)
Creates an MT526 initialized with the parameter MtSwiftMessage.MT526(SwiftMessage m)
Creates an MT526 initialized with the parameter SwiftMessage.MT526(java.io.File file)
Creates a new MT526 by parsing a file with the message content in its swift FIN format.MT526(java.io.InputStream stream)
Creates a new MT526 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.MT526(java.lang.String fin)
Creates a new MT526 by parsing a String with the message content in its swift FIN format.MT526(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT526 input message from sender to receiver.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MT526
append(Field... fields)
Add all the fields to the end of the block4.MT526
append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.MT526
append(Tag... tags)
Add all tags to the end of the block4.static MT526
fromJson(java.lang.String json)
Creates an MT526 messages from its JSON representation.Field20
getField20()
Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.Field21
getField21()
Iterates through block4 fields and return the first one whose name matches 21, or null if none is found.Field23
getField23()
Iterates through block4 fields and return the first one whose name matches 23, or null if none is found.Field29A
getField29A()
Iterates through block4 fields and return the first one whose name matches 29A, or null if none is found.Field29B
getField29B()
Iterates through block4 fields and return the first one whose name matches 29B, 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, orCollections.emptyList()
if none is found.java.util.List<Field31F>
getField31F()
Iterates through block4 fields and return all occurrences of fields whose names matches 31F, orCollections.emptyList()
if none is found.java.util.List<Field35A>
getField35A()
Iterates through block4 fields and return all occurrences of fields whose names matches 35A, orCollections.emptyList()
if none is found.java.util.List<Field35B>
getField35B()
Iterates through block4 fields and return all occurrences of fields whose names matches 35B, orCollections.emptyList()
if none is found.java.util.List<Field72>
getField72()
Iterates through block4 fields and return all occurrences of fields whose names matches 72, orCollections.emptyList()
if none is found.Field83C
getField83C()
Iterates through block4 fields and return the first one whose name matches 83C, or null if none is found.java.util.List<Field87A>
getField87A()
Iterates through block4 fields and return all occurrences of fields whose names matches 87A, orCollections.emptyList()
if none is found.java.util.List<Field87D>
getField87D()
Iterates through block4 fields and return all occurrences of fields whose names matches 87D, orCollections.emptyList()
if none is found.java.lang.String
getMessageType()
Returns this MT number.MT526.SequenceA
getSequenceA()
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.MT526.SequenceA
getSequenceA(SwiftTagListBlock parentSequence)
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.static MT526
parse(MtSwiftMessage m)
Creates an MT526 initialized with the parameter MtSwiftMessage.static MT526
parse(java.io.File file)
Creates a new MT526 by parsing a file with the message content in its swift FIN format.static MT526
parse(java.io.InputStream stream)
Creates a new MT526 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.static MT526
parse(java.lang.String fin)
Creates a new MT526 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
-
-
-
-
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
-
MT526
public MT526(SwiftMessage m)
Creates an MT526 initialized with the parameter SwiftMessage.- Parameters:
m
- swift message with the MT526 content
-
MT526
public MT526(MtSwiftMessage m)
Creates an MT526 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT526 content, the parameter can not be null- See Also:
MT526(String)
-
MT526
public MT526()
Creates and initializes a new MT526 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.- Since:
- 7.6
-
MT526
public MT526(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT526 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 charactersreceiver
- the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters- Since:
- 7.7
-
MT526
public MT526(java.lang.String fin)
Creates a new MT526 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
-
MT526
public MT526(java.io.InputStream stream) throws java.io.IOException
Creates a new MT526 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
-
MT526
public MT526(java.io.File file) throws java.io.IOException
Creates a new MT526 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 MT526 parse(MtSwiftMessage m)
Creates an MT526 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT526 content- Returns:
- the created object or null if the parameter is null
- Since:
- 7.7
- See Also:
MT526(String)
-
parse
public static MT526 parse(java.lang.String fin)
Creates a new MT526 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT526 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 MT526 or null if fin is null
- Since:
- 7.7
-
parse
public static MT526 parse(java.io.InputStream stream) throws java.io.IOException
Creates a new MT526 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 MT526 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 MT526 parse(java.io.File file) throws java.io.IOException
Creates a new MT526 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 MT526 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 classAbstractMT
- Returns:
- the message type number of this MT
- Since:
- 6.4
-
append
public MT526 append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
block
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT526 append(Tag... tags)
Add all tags to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
tags
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT526 append(Field... fields)
Add all the fields to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
fields
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
fromJson
public static MT526 fromJson(java.lang.String json)
Creates an MT526 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 MT526 message- Returns:
- a new instance of MT526
- 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 MT526 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)
-
getField21
public Field21 getField21()
Iterates through block4 fields and return the first one whose name matches 21, or null if none is found. The first occurrence of field 21 at MT526 is expected to be the only one.- Returns:
- a Field21 object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField23
public Field23 getField23()
Iterates through block4 fields and return the first one whose name matches 23, or null if none is found. The first occurrence of field 23 at MT526 is expected to be the only one.- Returns:
- a Field23 object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField83C
public Field83C getField83C()
Iterates through block4 fields and return the first one whose name matches 83C, or null if none is found. The first occurrence of field 83C at MT526 is expected to be the only one.- Returns:
- a Field83C object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField29A
public Field29A getField29A()
Iterates through block4 fields and return the first one whose name matches 29A, or null if none is found. The first occurrence of field 29A at MT526 is expected to be the only one.- Returns:
- a Field29A object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField29B
public Field29B getField29B()
Iterates through block4 fields and return the first one whose name matches 29B, or null if none is found. The first occurrence of field 29B at MT526 is expected to be the only one.- Returns:
- a Field29B object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField35B
public java.util.List<Field35B> getField35B()
Iterates through block4 fields and return all occurrences of fields whose names matches 35B, orCollections.emptyList()
if none is found. Multiple occurrences of field 35B at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field35B objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField35A
public java.util.List<Field35A> getField35A()
Iterates through block4 fields and return all occurrences of fields whose names matches 35A, orCollections.emptyList()
if none is found. Multiple occurrences of field 35A at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field35A 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, orCollections.emptyList()
if none is found. Multiple occurrences of field 30 at MT526 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)
-
getField31F
public java.util.List<Field31F> getField31F()
Iterates through block4 fields and return all occurrences of fields whose names matches 31F, orCollections.emptyList()
if none is found. Multiple occurrences of field 31F at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field31F objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField87A
public java.util.List<Field87A> getField87A()
Iterates through block4 fields and return all occurrences of fields whose names matches 87A, orCollections.emptyList()
if none is found. Multiple occurrences of field 87A at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field87A objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField87D
public java.util.List<Field87D> getField87D()
Iterates through block4 fields and return all occurrences of fields whose names matches 87D, orCollections.emptyList()
if none is found. Multiple occurrences of field 87D at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field87D objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField72
public java.util.List<Field72> getField72()
Iterates through block4 fields and return all occurrences of fields whose names matches 72, orCollections.emptyList()
if none is found. Multiple occurrences of field 72 at MT526 are expected at one sequence or across several sequences.- Returns:
- a List of Field72 objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getSequenceA
@SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL) public MT526.SequenceA getSequenceA()
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur only once according to the Standard. If block 4 is empty this method returns null.- Returns:
- the found sequence or an empty sequence if none is found
- See Also:
SwiftTagListBlock.getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
-
getSequenceA
@SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL) public MT526.SequenceA getSequenceA(SwiftTagListBlock parentSequence)
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail. The presence of this method indicates that this sequence can occur only once according to the Standard. If block 4 is empty this method returns null.- Parameters:
parentSequence
- a not null parent sequence to find SequenceA within it- Returns:
- the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty
- Since:
- 7.7
- See Also:
SwiftTagListBlock.getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
-
-