com.adventnet.tl1.message
Class TL1ResponseID

java.lang.Object
  |
  +--com.adventnet.tl1.message.TL1ResponseID

All Implemented Interfaces:

java.io.Serializable

public class TL1ResponseID

extends java.lang.Object

implements java.io.Serializable

This class represents the Reponse Identifier block of the TL1 Response Message. This block consists of three components, namely the Character M, a correlationtag and a completion code.

TL1 Response Message block

Components of the TL1ResponseID

The character M signifies the message is a response to an input message.

The correlation tag is used to correlate the input message with this output message. The completion code represents the status of the response message.

The possible values of completion code are,

 COMPLD - Represents total successful execution of the input command.
 DENY   - Represents total denial of the input command.
 PRTL   - Represents partial successful execution of the input command.
 DELAY  - Represents successful queuing of the input command for delayed
 activation.
 RTRV   - Represents output response of an input retrieve command.
 

For example, the ResponseId

M 123 COMPLD

is created as follows,

     TL1ResponseID  responseid = new TL1ResponseID():
     responseid.setCorrelationTag("123");
     responseid.setCompletionCode("TL1ResponseMessage.COMPLETED");
 

See Also:

TL1ResponseMessage.COMPLETED, TL1ResponseMessage.DENIED, TL1ResponseMessage.PARTIAL_SUCCESS, TL1ResponseMessage.DELAYED_ACTIVATION, TL1ResponseMessage.RETRIEVE, TL1ResponseMessage, Serialized Form

Constructor Summary

TL1ResponseID()
Default constructor that creates an instance of the TL1ResponseID object.

TL1ResponseID(java.lang.String correlationTag, java.lang.String completionCode)
Constructor which creates an instance of TL1ResponseID object and initializes the correlation tag and completion code fields in this block with the given values.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
java.lang.String	getCompletionCode() Gets the completion code of the response message.
java.lang.String	getCorrelationTag() Gets the Correlation Tag (CTag) which is used to correlate the input message with this ouput message.
void	setCompletionCode(java.lang.String completionCode) Sets the completion code with the given value.
void	setCorrelationTag(java.lang.String correlationTag) Sets the Correlation Tag (CTag), used to correlate the input message with this ouput message.
java.lang.String	toString() Returns the String form of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TL1ResponseID

public TL1ResponseID()

Default constructor that creates an instance of the TL1ResponseID object.

TL1ResponseID

public TL1ResponseID(java.lang.String correlationTag,
                     java.lang.String completionCode)

Constructor which creates an instance of TL1ResponseID object and initializes the correlation tag and completion code fields in this block with the given values.

Parameters:

correlationTag - String representing the CTag value.

completionCode - String representing the command completion code.

Method Detail

getCorrelationTag

public java.lang.String getCorrelationTag()

Gets the Correlation Tag (CTag) which is used to correlate the input message with this ouput message.

Returns:

String representing the Correlation Tag.

setCorrelationTag

public void setCorrelationTag(java.lang.String correlationTag)

Sets the Correlation Tag (CTag), used to correlate the input message with this ouput message.

Parameters:

correlationTag - String value of the CTag to set.

getCompletionCode

public java.lang.String getCompletionCode()

Gets the completion code of the response message. The completion code specifies the status of the response message.

Returns:

String representing the completion code.

See Also:

TL1ResponseMessage.COMPLETED, TL1ResponseMessage.DENIED, TL1ResponseMessage.PARTIAL_SUCCESS, TL1ResponseMessage.DELAYED_ACTIVATION, TL1ResponseMessage.RETRIEVE

setCompletionCode

public void setCompletionCode(java.lang.String completionCode)

Sets the completion code with the given value. The completion code specifies the status of the response message.

Parameters:

completionCode - String representing the completion code.

See Also:

TL1ResponseMessage.COMPLETED, TL1ResponseMessage.DENIED, TL1ResponseMessage.PARTIAL_SUCCESS, TL1ResponseMessage.DELAYED_ACTIVATION, TL1ResponseMessage.RETRIEVE

toString

public java.lang.String toString()

Returns the String form of this object.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this object.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.