biz.c24.io.api.data.swift
Class SwiftMessage

java.lang.Object
  extended by biz.c24.io.api.data.swift.SwiftMessage

public class SwiftMessage
extends Object

A wrapper object for SWIFT messages.
Contains various convenience methods for accessing relevant SWIFT message information from the underlying ComplexDataObject.


Constructor Summary
SwiftMessage(ComplexDataObject rootObject)
          Constructs a new SwiftMessage wrapper data object from a ComplexDataObject.
 
Method Summary
 ComplexDataObject getBlock1()
          Return the Basic Header Block of this SWIFT message.
 ComplexDataObject getBlock2()
          Return FIN Application Header Input or Output Block of this SWIFT message.
 ComplexDataObject getBlock3()
          Return the User Header Block of this SWIFT message.
 ComplexDataObject getBlock4()
          Return the Text Block of this SWIFT message.
 ComplexDataObject getBlock5()
          Return the Trailer Block of this SWIFT message.
 ComplexDataObject getMessageObject()
          Return the underlying ComplexDataObject representing the structure of this SWIFT message.
 int getMessageType()
          Return the message type for this SWIFT message i.e.: 564, 103, etc.
 int getSequenceNumber()
          Returns an int value representing the sequence number of this message.
 int getSessionNumber()
          Returns an int value representing the session number of this message.
 ComplexDataObject getSourceLTAddress()
          Get the Source LT Address for this SWIFT message.
 ComplexDataObject getTargetLTAddress()
          Get the target LT address for this SWIFT message.
 boolean isAck()
          Returns a boolean value indicating whether this SWIFT message is an Acknowledgement message.
 boolean isIncoming()
          Returns a boolean value indicating whether this SWIFT message is a messsage incoming to SWIFT, i.e. sent by the user.
 boolean isNak()
          Returns a boolean value indicating whether this SWIFT message is a Not Acknowledged message.
 boolean isOutgoing()
          Returns a boolean value indicating whether this SWIFT message is messsage outgoing from SWIFT, i.e. sent to the user.
 boolean isServiceMessage()
          Returns a boolean value indicating whether this SWIFT message is a service message.
 boolean isSystemMessage()
          Returns a boolean value indicating whether this SWIFT message is a system message.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SwiftMessage

public SwiftMessage(ComplexDataObject rootObject)
Constructs a new SwiftMessage wrapper data object from a ComplexDataObject.

Parameters:
rootObject - The SWIFT messaage to wrap.
Method Detail

getMessageType

public int getMessageType()
Return the message type for this SWIFT message i.e.: 564, 103, etc.

Returns:
The int value representing this message's type or -1 if the message type cannot be retrieved.

isIncoming

public boolean isIncoming()
Returns a boolean value indicating whether this SWIFT message is a messsage incoming to SWIFT, i.e. sent by the user.

Returns:
Whether this is an incoming message.

isOutgoing

public boolean isOutgoing()
Returns a boolean value indicating whether this SWIFT message is messsage outgoing from SWIFT, i.e. sent to the user.

Returns:
Whether this is an outgoing message.

isSystemMessage

public boolean isSystemMessage()
Returns a boolean value indicating whether this SWIFT message is a system message.

Returns:
Whether this is a system message.

isServiceMessage

public boolean isServiceMessage()
Returns a boolean value indicating whether this SWIFT message is a service message.

Returns:
Whether this is a service message.

isAck

public boolean isAck()
Returns a boolean value indicating whether this SWIFT message is an Acknowledgement message.

Returns:
Whether this is an Acknowledgement message.

isNak

public boolean isNak()
Returns a boolean value indicating whether this SWIFT message is a Not Acknowledged message.

Returns:
Whether this is a Not Acknowledged message.

getBlock1

public ComplexDataObject getBlock1()
Return the Basic Header Block of this SWIFT message.

Returns:
The Basic Header Block.

getBlock2

public ComplexDataObject getBlock2()
Return FIN Application Header Input or Output Block of this SWIFT message.

Returns:
The FIN Application Header Input or Output Block.

getBlock3

public ComplexDataObject getBlock3()
Return the User Header Block of this SWIFT message.

Returns:
The User Header Block.

getBlock4

public ComplexDataObject getBlock4()
Return the Text Block of this SWIFT message.

Returns:
The Text Block.

getBlock5

public ComplexDataObject getBlock5()
Return the Trailer Block of this SWIFT message.

Returns:
The Trailer Block.

getSourceLTAddress

public ComplexDataObject getSourceLTAddress()
Get the Source LT Address for this SWIFT message.

Returns:
The source LT address.

getTargetLTAddress

public ComplexDataObject getTargetLTAddress()
Get the target LT address for this SWIFT message.

Returns:
The target LT address.

getSessionNumber

public int getSessionNumber()
Returns an int value representing the session number of this message.

Returns:
The session number.

getSequenceNumber

public int getSequenceNumber()
Returns an int value representing the sequence number of this message.

Returns:
The sequence number.

getMessageObject

public ComplexDataObject getMessageObject()
Return the underlying ComplexDataObject representing the structure of this SWIFT message.

Returns:
rootObject ComplexDataObject.


C24 Technologies © 2002-2012: All Rights Reserved.