com.prowidesoftware.swift.model

Class SwiftBlock2Output

java.lang.Object

com.prowidesoftware.swift.model.SwiftBlock

com.prowidesoftware.swift.model.SwiftValueBlock

com.prowidesoftware.swift.model.SwiftBlock2

com.prowidesoftware.swift.model.SwiftBlock2Output

All Implemented Interfaces:

Serializable

public class SwiftBlock2Output
extends SwiftBlock2
implements Serializable

Base class for SWIFT Application Header Block (block 2) for OUTPUT (from SWIFT).
This block is used to construct messages that have been output from the SWIFT network. From the application point of view, it correspond to the RECEIVED messages.

It's value is fixed-length and continuous with no field delimiters. This class contains its elements as individual attributes for easier management of the block value.

For a received message, a message being output from SWIFT, the SwiftBlock2Output includes explicit information regarding the MIR. This is sometimes confusing because it is an output block with an input reference. The important thing to understand here is that the MIR information is related to the original sender of the message that has been received. The attributes of this header (block 2 output) are explicitly documented as MIR information by SWIFT.

The MOR itself could be created combining information from block 1 and 2 but it usually does not make sense.

Since:

4.0

Author:

www.prowidesoftware.com

See Also:

MIR, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.prowidesoftware.swift.model.SwiftBlock2

SwiftBlock2.MessagePriority

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.SwiftBlock2

messagePriority, messageType

Fields inherited from class com.prowidesoftware.swift.model.SwiftBlock

blockType, id, input, output, unparsedTexts

Constructor Summary

Constructors

Constructor and Description
SwiftBlock2Output() Default Constructor
SwiftBlock2Output(String value) Creates the block with lenient false, meaning it expects a fixed length value.
SwiftBlock2Output(String value, boolean lenient) Creates a block 2 output object setting attributes by parsing the string argument containing the blocks value.
SwiftBlock2Output(String messageType, String senderInputTime, String MIRDate, String MIRLogicalTerminal, String MIRSessionNumber, String MIRSequenceNumber, String receiverOutputDate, String receiverOutputTime, String messagePriority) Constructor for specific values

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	field(SwiftBlock2OutputField field) Generic getter for block attributes based on qualified names from SwiftBlock2OutputField
String	getBlockValue() This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
String	getMIR() Gets the full MIR (Message Input Reference) string of 28 characters containing the sender's date, LT address, session and sequence: for example YYMMDDBANKBEBBAXXX2222123456
String	getMIRDate() Gets the date the sender sent the message to SWIFT, from the MIR field, in the format YYMMDD
String	getMIRLogicalTerminal() Gets the the full LT address of the sender of the message, from the MIR field, for example: BANKBEBBAXXX
String	getMIRSequenceNumber() Gets the date the sender sequence number, from the MIR field, in the format NNNNNN
String	getMIRSessionNumber() Gets the date the sender session number, from the MIR field, in the format NNNN
String	getReceiverOutputDate() Gets the Output date local to the receiver
String	getReceiverOutputTime() Gets the Output time local to the receiver, written in the following format: HHMM
BIC	getSenderBIC() Gets the sender's BIC code. For output message the sender address is contained in this block2 and not in the header block 1 as for input messages.
String	getSenderInputTime() Returns the input time with respect to the sender
String	getValue() Gets the fixed length block 2 value, as a result of concatenating its individual elements as follow: Message Type + Sender Input Time + MIR + Receiver Output Date + Receiver Output Time + Message Priority.
int	hashCode()
boolean	isEmpty() Tell if this block is empty or not.
void	setBlockValue(String value) This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
void	setField(SwiftBlock2OutputField field, String value) Generic setter for block attributes based on qualified names from SwiftBlock2OutputField
void	setMIR(String mir) Sets the full MIR (Message Input Reference) from a fixed length (28 characters) string containing the complete MIR value.
void	setMIR(String mir, boolean lenient) Sets the MIR (Message Input Reference) attributes by parsing the string argument containing the complete MIR value. For example YYMMDDBANKBEBBAXXX2222123456
void	setMIRDate(String MIRDate) Sets the date the sender sent the message to SWIFT, from the MIR field
void	setMIRLogicalTerminal(LogicalTerminalAddress MIRLogicalTerminal) Sets the the full LT address of the sender of the message.
void	setMIRLogicalTerminal(String MIRLogicalTerminal) Sets the the full LT address of the sender of the message.
void	setMIRSequenceNumber(String MIRSequenceNumber) Sets the sequence number field of the MIR
void	setMIRSessionNumber(String MIRSessionNumber) Sets the session number field of the MIR
void	setReceiverOutputDate(String receiverOutputDate) Sets the Output date local to the receiver, written in the following format: YYMMDD
void	setReceiverOutputTime(String receiverOutputTime) Sets the Output time local to the receiver, written in the following format: HHMM
void	setSender(BIC bic) Creates a full LT address using the parameter BIC code and a default LT identifier, and sets the resulting address as MIR logical terminal address.
void	setSender(String sender) Completes if necessary and sets the LT address of the sender as MIR logical terminal address. The sender addresses will be filled with proper default LT identifier and branch codes if not provided.
void	setSenderInputTime(String senderInputTime) Sets the input time with respect to the sender
void	setValue(String value) Sets the block's attributes by parsing the fixed length string argument.
void	setValue(String value, boolean lenient) Sets the block's attributes by parsing the string argument containing the blocks value. This value can be in different flavors because some fields are optional. Example of supported values:
String	toJson() intended to be overwritten

Methods inherited from class com.prowidesoftware.swift.model.SwiftBlock2

clean, field, getMessagePriority, getMessagePriorityType, getMessageType, getName, getNumber, isInput, isOutput, setBlockName, setBlockNumber, setField, setMessagePriority, setMessageType, toString

Methods inherited from class com.prowidesoftware.swift.model.SwiftValueBlock

getValuePart, getValuePart, size

Methods inherited from class com.prowidesoftware.swift.model.SwiftBlock

getBlockType, getId, getInput, getOutput, getUnparsedTexts, getUnparsedTextsSize, isTagBlock, setBlockType, setId, setInput, setOutput, setUnparsedTexts, unparsedTextAddText, unparsedTextAddText, unparsedTextGetAsMessage, unparsedTextGetText, unparsedTextIsMessage, unparsedTextVerify

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SwiftBlock2Output

public SwiftBlock2Output(String messageType,
                 String senderInputTime,
                 String MIRDate,
                 String MIRLogicalTerminal,
                 String MIRSessionNumber,
                 String MIRSequenceNumber,
                 String receiverOutputDate,
                 String receiverOutputTime,
                 String messagePriority)

Constructor for specific values

Parameters:

messageType - the message type

senderInputTime - the input time

MIRDate - date

MIRLogicalTerminal - logical terminal

MIRSessionNumber - session number

MIRSequenceNumber - message sequence number

receiverOutputDate - receiver date

receiverOutputTime - receiver time

messagePriority - the message priority (S=system, U=urgent, N=normal)

SwiftBlock2Output

public SwiftBlock2Output(String value)

Creates the block with lenient false, meaning it expects a fixed length value. Example of supported values:
"O1001200970103BANKBEBBAXXX22221234569701031201N" or "2:O1001200970103BANKBEBBAXXX22221234569701031201N"

Parameters:

value - a fixed length string of 46 (starting with 'O') or 49 (starting with '2:O') characters containing the blocks value

Throws:

IllegalArgumentException - if parameter is not 47 or 49 characters

See Also:

SwiftBlock2Output(String, boolean)

SwiftBlock2Output

public SwiftBlock2Output(String value,
                 boolean lenient)

Creates a block 2 output object setting attributes by parsing the string argument containing the blocks value. This value can be in different flavors because some fields are optional.

Parameters:

value - string containing the entire blocks value

lenient - if true the value will be parsed with a best effort heuristic, if false it will throw a IllegalArgumentException if the value has an invalid total size

Since:

7.7

See Also:

setValue(String, boolean)

SwiftBlock2Output

public SwiftBlock2Output()

Default Constructor

Method Detail

setSenderInputTime

public void setSenderInputTime(String senderInputTime)

Sets the input time with respect to the sender

Parameters:

senderInputTime - 4 numbers HHMM

getSenderInputTime

public String getSenderInputTime()

Returns the input time with respect to the sender

Returns:

4 numbers HHMM

setMIRDate

public void setMIRDate(String MIRDate)

Sets the date the sender sent the message to SWIFT, from the MIR field

Parameters:

MIRDate - 6 numbers with date in format YYMMDD

getMIRDate

public String getMIRDate()

Gets the date the sender sent the message to SWIFT, from the MIR field, in the format YYMMDD

Returns:

String with 6 numbers

setMIRLogicalTerminal

public void setMIRLogicalTerminal(String MIRLogicalTerminal)

Sets the the full LT address of the sender of the message.

Parameters:

MIRLogicalTerminal - 12 characters full LT address

setMIRLogicalTerminal

public void setMIRLogicalTerminal(LogicalTerminalAddress MIRLogicalTerminal)

Sets the the full LT address of the sender of the message.

Parameters:

MIRLogicalTerminal - 12 characters full LT address

Since:

7.6

See Also:

LogicalTerminalAddress.getSenderLogicalTerminalAddress()

setSender

public void setSender(BIC bic)

Creates a full LT address using the parameter BIC code and a default LT identifier, and sets the resulting address as MIR logical terminal address.

Parameters:

bic -

Since:

7.6

See Also:

setMIRLogicalTerminal(LogicalTerminalAddress)

setSender

public void setSender(String sender)

Completes if necessary and sets the LT address of the sender as MIR logical terminal address.
The sender addresses will be filled with proper default LT identifier and branch codes if not provided.

Since:

7.6

See Also:

setMIRLogicalTerminal(LogicalTerminalAddress)

getMIRLogicalTerminal

public String getMIRLogicalTerminal()

Gets the the full LT address of the sender of the message, from the MIR field, for example: BANKBEBBAXXX

Returns:

LT address

getSenderBIC

public BIC getSenderBIC()

Gets the sender's BIC code.
For output message the sender address is contained in this block2 and not in the header block 1 as for input messages.

Returns:

sender BIC address

Since:

7.6

See Also:

BIC

setMIRSessionNumber

public void setMIRSessionNumber(String MIRSessionNumber)

Sets the session number field of the MIR

Parameters:

MIRSessionNumber - 4 numbers

getMIRSessionNumber

public String getMIRSessionNumber()

Gets the date the sender session number, from the MIR field, in the format NNNN

Returns:

4 numbers

setMIRSequenceNumber

public void setMIRSequenceNumber(String MIRSequenceNumber)

Sets the sequence number field of the MIR

Parameters:

MIRSequenceNumber - 6 numbers

getMIRSequenceNumber

public String getMIRSequenceNumber()

Gets the date the sender sequence number, from the MIR field, in the format NNNNNN

Returns:

6 numbers

getMIR

public String getMIR()

Gets the full MIR (Message Input Reference) string of 28 characters containing the sender's date, LT address, session and sequence:
for example YYMMDDBANKBEBBAXXX2222123456

Returns:

a String with MIR, returns null if all MIR components are null

setMIR

public void setMIR(String mir)

Sets the full MIR (Message Input Reference) from a fixed length (28 characters) string containing the complete MIR value.

Parameters:

mir - complete MIR string value, a fixed length (28 characters) string containing the MIR value

Throws:

IllegalArgumentException - if parameter has an invalid total size.

See Also:

setMIR(String, boolean)

setMIR

public void setMIR(String mir,
          boolean lenient)

Sets the MIR (Message Input Reference) attributes by parsing the string argument containing the complete MIR value.
For example YYMMDDBANKBEBBAXXX2222123456

Parameters:

mir - complete MIR string

lenient - if true the value will be parsed with a best effort heuristic, if false it will throw a IllegalArgumentException if the value has an invalid total size

setReceiverOutputDate

public void setReceiverOutputDate(String receiverOutputDate)

Sets the Output date local to the receiver, written in the following format: YYMMDD

Parameters:

receiverOutputDate - 6 characters in format YYMMDD

getReceiverOutputDate

public String getReceiverOutputDate()

Gets the Output date local to the receiver

Returns:

6 characters in format YYMMDD

setReceiverOutputTime

public void setReceiverOutputTime(String receiverOutputTime)

Sets the Output time local to the receiver, written in the following format: HHMM

Parameters:

receiverOutputTime - String with 4 numbers

getReceiverOutputTime

public String getReceiverOutputTime()

Gets the Output time local to the receiver, written in the following format: HHMM

Returns:

String with 4 numbers

isEmpty

public boolean isEmpty()

Tell if this block is empty or not. This block is considered to be empty if all its attributes are set to null.

Overrides:

isEmpty in class SwiftValueBlock

Returns:

true if all fields are null and false in other case

getValue

public String getValue()

Gets the fixed length block 2 value, as a result of concatenating its individual elements as follow:
Message Type + Sender Input Time + MIR + Receiver Output Date + Receiver Output Time + Message Priority.

Overrides:

getValue in class SwiftValueBlock

Returns:

the blocks value as a single string

getBlockValue

public String getBlockValue()

Description copied from class: SwiftValueBlock

This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Overrides:

getBlockValue in class SwiftValueBlock

Returns:

N/A

See Also:

getValue()

setValue

public void setValue(String value)

Sets the block's attributes by parsing the fixed length string argument.

Overrides:

setValue in class SwiftValueBlock

Parameters:

value - a fixed length (between 46 and 49) string containing the blocks' value

Throws:

IllegalArgumentException - if parameter has an invalid total size.

See Also:

setValue(String, boolean)

setValue

public void setValue(String value,
            boolean lenient)

Sets the block's attributes by parsing the string argument containing the blocks value.
This value can be in different flavors because some fields are optional.
Example of supported values:

   "O1001200970103BANKBEBBAXXX22221234569701031201" (46) or
   "2:O1001200970103BANKBEBBAXXX22221234569701031201" (48)   // used for service/system messages
   "O1001200970103BANKBEBBAXXX22221234569701031201N" (47) or
   "2:O1001200970103BANKBEBBAXXX22221234569701031201N" (49)
 

Parameters:

value - string containing the entire blocks value

lenient - if true the value will be parsed with a best effort heuristic, if false it will throw a IllegalArgumentException if the value has an invalid total size

setBlockValue

public void setBlockValue(String value)

Description copied from class: SwiftValueBlock

This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Overrides:

setBlockValue in class SwiftValueBlock

Parameters:

value - unused

See Also:

setValue(String)

hashCode

public int hashCode()

Overrides:

hashCode in class SwiftBlock2

equals

public boolean equals(Object obj)

Overrides:

equals in class SwiftBlock2

toJson

public String toJson()

Description copied from class: SwiftBlock2

intended to be overwritten

Overrides:

toJson in class SwiftBlock2

Since:

7.5

field

public String field(SwiftBlock2OutputField field)

Generic getter for block attributes based on qualified names from SwiftBlock2OutputField

Parameters:

field - field to get

Returns:

field value or null if attribute is not set

Since:

7.7

setField

public void setField(SwiftBlock2OutputField field,
            String value)

Generic setter for block attributes based on qualified names from SwiftBlock2OutputField

Parameters:

field - field to get

value - content to set

Since:

7.8