com.adventnet.tl1.message
Class TL1ResponseID

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

public class TL1ResponseID

extends java.lang.Object

This class represents the Reponse Identification object which identifies the type of Output Response Message.

TL1 Response Message block

Components of the TL1ResponseID

The correlation tag 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.
 

See Also:

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

Constructor Summary

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

TL1ResponseID(java.lang.String correlationTag, java.lang.String completionCode)
Constructor that creates an instance of TL1ResponseID object and initializes the correlation tag and completion code with the given default value.

Method Summary

java.lang.String	getCompletionCode() Get the completion code.
java.lang.String	getCorrelationTag() Get the Correlation Tag (CTag) used to correlate the input message with this ouput message.
void	setCompletionCode(java.lang.String completionCode) Set the completion code with the given value.
void	setCorrelationTag(java.lang.String correlationTag) Set the Correlation Tag (CTag), used to correlate the input message with this ouput message.
java.lang.String	toString() Returns a stringified form of this Response ID object.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TL1ResponseID

public TL1ResponseID()

Default constructor that creates an instance of TL1ResponseID object.

TL1ResponseID

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

Constructor that creates an instance of TL1ResponseID object and initializes the correlation tag and completion code with the given default value.

Parameters:

correlationTag - String representing the CTag value.

completionCode - String representing the command completion code.

Method Detail

getCorrelationTag

public java.lang.String getCorrelationTag()

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

Returns:

String representing the Correlation Tag.

setCorrelationTag

public void setCorrelationTag(java.lang.String correlationTag)

Set 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()

Get the completion code. It specifies the status of the response message.

Returns:

String representing completion code.

See Also:

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

setCompletionCode

public void setCompletionCode(java.lang.String completionCode)

Set the completion code with the given value. It 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 a stringified form of this Response ID object.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this object.