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	mFTCallID
protected java.lang.String	mHash
protected java.lang.String	mReferrer
protected java.lang.String	mToken
protected java.lang.String	mUsername
protected java.lang.String	mUserTelephoneNumber

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, REFERRER_PARAMETER_NAME, SESSION_ATTRIBUTE_NAME, TOKEN_PARAMETER_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	getFTCallID() Returns the FTCallID param value received on the original automated request to start the call.
java.lang.String	getHash() Returns the hash param value received on the original automated request to start the call.
java.lang.String	getReferrer() Returns the Referring page from a C2C Session
java.lang.String	getToken() Returns the Token used to identify a C2C Session
java.lang.String	getUsername() Returns the user name param value received on the original automated request to start the call.
java.lang.String	getUserTelephoneNumber() The user telephone number for the call
void	setC2CWebServiceResponse(C2CWebServiceResponse pC2CWebServiceResponse) Set property C2CWebServiceResponse
void	setClickToConnectApplicationData(atg.repository.RepositoryItem pClickToConnectApplicationData)
void	setFTCallID(java.lang.String pFTCallID)
void	setHash(java.lang.String pHash)
void	setReferrer(java.lang.String pReferrer)
void	setToken(java.lang.String pToken)
void	setUsername(java.lang.String pUsername)
void	setUserTelephoneNumber(java.lang.String pUserTelephoneNumber)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mC2CWebServiceResponse

protected C2CWebServiceResponse mC2CWebServiceResponse

mFTCallID

protected java.lang.String mFTCallID

mUserTelephoneNumber

protected java.lang.String mUserTelephoneNumber

mUsername

protected java.lang.String mUsername

mHash

protected java.lang.String mHash

mToken

protected java.lang.String mToken

mReferrer

protected java.lang.String mReferrer

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

getReferrer

public java.lang.String getReferrer()

Returns the Referring page from a C2C Session

Returns:

String

setReferrer

public void setReferrer(java.lang.String pReferrer)

getToken

public java.lang.String getToken()

Returns the Token used to identify a C2C Session

Returns:

String

setToken

public void setToken(java.lang.String pToken)

getFTCallID

public java.lang.String getFTCallID()

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

Returns:

String

setFTCallID

public void setFTCallID(java.lang.String pFTCallID)

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)

getUserTelephoneNumber

public java.lang.String getUserTelephoneNumber()

The user telephone number for the call

Returns:

String

setUserTelephoneNumber

public void setUserTelephoneNumber(java.lang.String pUserTelephoneNumber)

getHash

public java.lang.String getHash()

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

Returns:

String

setHash

public void setHash(java.lang.String pHash)

getUsername

public java.lang.String getUsername()

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

setUsername

public void setUsername(java.lang.String pUsername)