public class ConfirmationInfo
extends java.lang.Object
CSRAgentTools
.
CSC provides a window scoped component of this type that various form handlers used to pass information to the confirmation page. This object provides the information for sending that confirmation email.
This object is input to the API in CSRAgentTools
that's used to send confirmation emails.
That API will also make the ConfirmatioInfo object available to the email template through
a predefined input parameter name.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
CONFIRMATIONINFO_PARAM_NAME
the name of the parameter used to pass the ConfirmationInfo object to the email template
|
protected java.lang.String |
mAutoConfirmationEmailAddress |
protected boolean |
mAutoConfirmationSent |
protected java.util.Locale |
mCustomerDisplayLocale |
protected java.util.Map |
mExtraData |
protected atg.commerce.order.Order |
mOrder |
protected atg.repository.RepositoryItem |
mProfile |
protected java.lang.String |
mTemplateName |
protected java.lang.String |
mToEmailAddress |
static java.lang.String |
SCHEDULE_PARAM_NAME
the key name used to store the schedule in the confirmation info's extra data map
|
static java.lang.String |
SCHEDULED_ORDER_ITEM_PARAM_NAME
the key name used to store the scheduled order item in the confirmation info's extra data map
|
Constructor and Description |
---|
ConfirmationInfo() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAutoConfirmationEmailAddress()
This property is used to store the address that was used to send
the auto confirmation email.
|
java.util.Locale |
getCustomerDisplayLocale()
Returns the customer's display locale which can be used
to format text of the email.
|
java.lang.String |
getCustomerDisplayLocaleString()
Returns the string value of the customer's display locale
|
java.util.Map |
getExtraData()
Returns the map of extra data.
|
atg.commerce.order.Order |
getOrder()
Returns the order associated with the confirmation
|
atg.repository.RepositoryItem |
getProfile()
Returns the profile associated with the confirmation
|
java.lang.String |
getTemplateName()
Returns the name of the email template to use when sending the
email.
|
java.lang.String |
getToEmailAddress()
Returns the email address associated with the confirmation
|
boolean |
isAutoConfirmationSent()
Returns true if the automatic confirmation email was sent for this confirmation
info
|
void |
reset()
Resets the state of this info object.
|
void |
setAutoConfirmationEmailAddress(java.lang.String pAutoConfirmationEmailAddress) |
void |
setAutoConfirmationSent(boolean pAutoConfirmationSent) |
void |
setCustomerDisplayLocale(java.util.Locale pCustomerDisplayLocale) |
void |
setExtraData(java.util.Map pExtraData) |
void |
setOrder(atg.commerce.order.Order pOrder) |
void |
setProfile(atg.repository.RepositoryItem pProfile) |
void |
setTemplateName(java.lang.String pTemplateName) |
void |
setToEmailAddress(java.lang.String pToEmailAddress) |
public static java.lang.String CLASS_VERSION
public static final java.lang.String CONFIRMATIONINFO_PARAM_NAME
public static final java.lang.String SCHEDULE_PARAM_NAME
public static final java.lang.String SCHEDULED_ORDER_ITEM_PARAM_NAME
protected atg.commerce.order.Order mOrder
protected atg.repository.RepositoryItem mProfile
protected java.util.Map mExtraData
protected java.lang.String mToEmailAddress
protected java.lang.String mTemplateName
protected boolean mAutoConfirmationSent
protected java.lang.String mAutoConfirmationEmailAddress
protected java.util.Locale mCustomerDisplayLocale
public java.util.Map getExtraData()
public void setExtraData(java.util.Map pExtraData)
public atg.commerce.order.Order getOrder()
public void setOrder(atg.commerce.order.Order pOrder)
public atg.repository.RepositoryItem getProfile()
public void setProfile(atg.repository.RepositoryItem pProfile)
public java.lang.String getToEmailAddress()
public void setToEmailAddress(java.lang.String pToEmailAddress)
public java.lang.String getTemplateName()
CSRAgentTools.getConfirmationEmailMap()
public void setTemplateName(java.lang.String pTemplateName)
public boolean isAutoConfirmationSent()
public void setAutoConfirmationSent(boolean pAutoConfirmationSent)
public java.lang.String getAutoConfirmationEmailAddress()
public void setAutoConfirmationEmailAddress(java.lang.String pAutoConfirmationEmailAddress)
public java.util.Locale getCustomerDisplayLocale()
public void setCustomerDisplayLocale(java.util.Locale pCustomerDisplayLocale)
public java.lang.String getCustomerDisplayLocaleString()
public void reset()