atg.svc.clicktoconnect
Class C2CRequestData

java.lang.Object
  atg.svc.clicktoconnect.C2CRequestData

All Implemented Interfaces:

C2CConstants

public class C2CRequestData
extends java.lang.Object
implements C2CConstants

This class is used to hold reference data for a click to connect operation.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected C2CWebServiceResponse	mC2CWebServiceResponse
atg.repository.RepositoryItem	mClickToConnectApplicationData
protected java.lang.String	mRequestedFTCallID
protected java.lang.String	mRequestedHash
protected java.lang.String	mRequestedUserTelephoneNumber
protected java.lang.String	mRequestUsername

Fields inherited from interface atg.svc.clicktoconnect.C2CConstants

C2CREQUESTDATA_CALLSTATE_KEY, CLICKTOCALL_INITIALIZE_PARAMETER_NAME, ENV_CHG_START_NEW_C2C_CALL, ENV_CHG_START_NEW_C2C_CALL_C2CREQUESTDATA_PARAM, ENV_CHG_START_NEW_C2C_CALL_USERPHONENUMBER_PARAM, FTCALLID_PARAMETER_NAME, HASH_PARAMETER_NAME, SESSION_ATTRIBUTE_NAME, USER_TELEPHONE_NUMBER_PARAMETER_NAME, USERNAME_PARAMETER_NAME

Constructor Summary

C2CRequestData()

Method Summary

C2CWebServiceResponse	getC2CWebServiceResponse() Get property C2CWebServiceResponse
atg.repository.RepositoryItem	getClickToConnectApplicationData() Returns the associated application click to connect repository item for this request
java.lang.String	getRequestedFTCallID() Returns the FTCallID param value received on the original automated request to start the call.
java.lang.String	getRequestedHash() Returns the hash param value received on the original automated request to start the call.
java.lang.String	getRequestedUsername() Returns the user name param value received on the original automated request to start the call.
java.lang.String	getRequestedUserTelephoneNumber() The user telephone number for the call
void	setC2CWebServiceResponse(C2CWebServiceResponse pC2CWebServiceResponse) Set property C2CWebServiceResponse
void	setClickToConnectApplicationData(atg.repository.RepositoryItem pClickToConnectApplicationData)
void	setRequestedFTCallID(java.lang.String pRequestedFTCallID)
void	setRequestedHash(java.lang.String pRequestedHash)
void	setRequestedUsername(java.lang.String pRequestedUsername)
void	setRequestedUserTelephoneNumber(java.lang.String pRequestedUserTelephoneNumber)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

mC2CWebServiceResponse

protected C2CWebServiceResponse mC2CWebServiceResponse

mRequestedFTCallID

protected java.lang.String mRequestedFTCallID

mRequestedUserTelephoneNumber

protected java.lang.String mRequestedUserTelephoneNumber

mRequestUsername

protected java.lang.String mRequestUsername

mRequestedHash

protected java.lang.String mRequestedHash

mClickToConnectApplicationData

public atg.repository.RepositoryItem mClickToConnectApplicationData

Constructor Detail

C2CRequestData

public C2CRequestData()

Method Detail

setC2CWebServiceResponse

public void setC2CWebServiceResponse(C2CWebServiceResponse pC2CWebServiceResponse)

Set property C2CWebServiceResponse

Parameters:

pC2CWebServiceResponse -

getC2CWebServiceResponse

public C2CWebServiceResponse getC2CWebServiceResponse()

Get property C2CWebServiceResponse

This object contains information related to the response received from the eStara web service.

Returns:

C2CWebServiceResponse

getRequestedFTCallID

public java.lang.String getRequestedFTCallID()

Returns the FTCallID param value received on the original automated request to start the call.

Returns:

String

setRequestedFTCallID

public void setRequestedFTCallID(java.lang.String pRequestedFTCallID)

getClickToConnectApplicationData

public atg.repository.RepositoryItem getClickToConnectApplicationData()

Returns the associated application click to connect repository item for this request

Returns:

RepositoryItem from the C2CRepository

setClickToConnectApplicationData

public void setClickToConnectApplicationData(atg.repository.RepositoryItem pClickToConnectApplicationData)

getRequestedUserTelephoneNumber

public java.lang.String getRequestedUserTelephoneNumber()

The user telephone number for the call

Returns:

String

setRequestedUserTelephoneNumber

public void setRequestedUserTelephoneNumber(java.lang.String pRequestedUserTelephoneNumber)

getRequestedHash

public java.lang.String getRequestedHash()

Returns the hash param value received on the original automated request to start the call.

Returns:

String

setRequestedHash

public void setRequestedHash(java.lang.String pRequestedHash)

getRequestedUsername

public java.lang.String getRequestedUsername()

Returns the user name param value received on the original automated request to start the call. This value should reflect the agent's login id.

This id is used to auto-authenticate the agent on the first request into the application after the launch on the browser window.

Returns:

String

setRequestedUsername

public void setRequestedUsername(java.lang.String pRequestedUsername)