com.mirth.connect.userutil
Class ValueReplacerConnectorMessage

java.lang.Object
  extended by com.mirth.connect.userutil.ValueReplacerConnectorMessage

public class ValueReplacerConnectorMessage
extends java.lang.Object

This class represents a connector message and is used to retrieve details such as the message ID, metadata ID, status, and various content types.


Constructor Summary
ValueReplacerConnectorMessage(ImmutableConnectorMessage connectorMessage)
          Instantiates an ValueReplacerConnectorMessage.
 
Method Summary
 java.lang.String getChannelId()
          Returns the ID of the channel associated with this connector message.
 java.lang.String getConnectorName()
          Returns the name of the connector associated with this connector message.
 java.lang.String getEncodedData()
          Retrieves encoded content associated with this connector message.
 long getId()
          Deprecated. This method is deprecated and will soon be removed. Please use getMessageId() instead.
 long getMessageId()
          Returns the sequential ID of the overall Message associated with this connector message.
 int getMetaDataId()
          Returns the metadata ID of this connector message.
 java.lang.String getRawData()
          Retrieves raw content associated with this connector message.
 java.util.Calendar getReceivedDate()
          Returns the date/time that this connector message was created by the channel.
 java.lang.String getServerId()
          Returns the ID of the server associated with this connector message.
 java.lang.String getSource()
          Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_source" variable in the connector map instead.
 Status getStatus()
          Returns the status (e.g.
 java.lang.String getTransformedData()
          Retrieves transformed content associated with this connector message.
 java.lang.String getType()
          Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_type" variable in the connector map instead.
 java.lang.String getVersion()
          Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_version" variable in the connector map instead.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ValueReplacerConnectorMessage

public ValueReplacerConnectorMessage(ImmutableConnectorMessage connectorMessage)
Instantiates an ValueReplacerConnectorMessage.

Parameters:
connectorMessage - The connector message that this object will reference for retrieving data.
Method Detail

getMetaDataId

public int getMetaDataId()
Returns the metadata ID of this connector message. Note that the source connector has a metadata ID of 0.


getChannelId

public java.lang.String getChannelId()
Returns the ID of the channel associated with this connector message.


getConnectorName

public java.lang.String getConnectorName()
Returns the name of the connector associated with this connector message.


getServerId

public java.lang.String getServerId()
Returns the ID of the server associated with this connector message.


getReceivedDate

public java.util.Calendar getReceivedDate()
Returns the date/time that this connector message was created by the channel.


getStatus

public Status getStatus()
Returns the status (e.g. SENT) of this connector message.


getRawData

public java.lang.String getRawData()
Retrieves raw content associated with this connector message.

Returns:
The raw content, as a string.

getTransformedData

public java.lang.String getTransformedData()
Retrieves transformed content associated with this connector message.

Returns:
The transformed content, as a string.

getEncodedData

public java.lang.String getEncodedData()
Retrieves encoded content associated with this connector message.

Returns:
The encoded content, as a string.

getMessageId

public long getMessageId()
Returns the sequential ID of the overall Message associated with this connector message.


getId

public long getId()
Deprecated. This method is deprecated and will soon be removed. Please use getMessageId() instead.

Returns the sequential ID of the overall Message associated with this connector message.


getSource

public java.lang.String getSource()
Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_source" variable in the connector map instead.

Returns the source of the message (dependent on the inbound data type).


getType

public java.lang.String getType()
Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_type" variable in the connector map instead.

Returns the type of the message (dependent on the inbound data type).


getVersion

public java.lang.String getVersion()
Deprecated. This method is deprecated and will soon be removed. Please use the "mirth_version" variable in the connector map instead.

Returns the version of the message (dependent on the inbound data type).


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object