ConfirmationInfo (ATG CSC API)

java.lang.Object
- atg.commerce.csr.order.ConfirmationInfo

```
public class ConfirmationInfo
extends java.lang.Object
```
This component holds information used to generate and send confirmation emails with the API defined in 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.

order

the order that is being confirmed.
extraData

a convenience map used for storing application objects that can be used from within the confirmation template

profile

the customer profile

toEmailAddress

the email address to which to send the email confirmation

templateName

the name of the template. This value is used by CSRAgentTools to identify the correct jsp template that is used when generating the email. /dd>
autoConfirmationSent

This value is set by the CSRAgentTools API when it attempts to send the auto confirmation email. If it was successful in sending the email, this value will be set to true.

autoConfirmationEmailAddress

This value is set by the CSRAgentTools API when it attempts to send the auto confirmation email. If it was successful in sending the email, this value will be set to the email address used to send the auto confirmation.

Field Summary

Fields
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 Summary

Constructors
Constructor and Description

ConfirmationInfo()

Constructors
Constructor and Description
`ConfirmationInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`

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
  - CONFIRMATIONINFO_PARAM_NAME
```
public static final java.lang.String CONFIRMATIONINFO_PARAM_NAME
```
    the name of the parameter used to pass the ConfirmationInfo object to the email template
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_PARAM_NAME
```
public static final java.lang.String SCHEDULE_PARAM_NAME
```
    the key name used to store the schedule in the confirmation info's extra data map
    
    See Also:
    
    Constant Field Values
  - SCHEDULED_ORDER_ITEM_PARAM_NAME
```
public static final 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
    
    See Also:
    
    Constant Field Values
  - mOrder
```
protected atg.commerce.order.Order mOrder
```
  - mProfile
```
protected atg.repository.RepositoryItem mProfile
```
  - mExtraData
```
protected java.util.Map mExtraData
```
  - mToEmailAddress
```
protected java.lang.String mToEmailAddress
```
  - mTemplateName
```
protected java.lang.String mTemplateName
```
  - mAutoConfirmationSent
```
protected boolean mAutoConfirmationSent
```
  - mAutoConfirmationEmailAddress
```
protected java.lang.String mAutoConfirmationEmailAddress
```
  - mCustomerDisplayLocale
```
protected java.util.Locale mCustomerDisplayLocale
```
- Constructor Detail
  - ConfirmationInfo
```
public ConfirmationInfo()
```
- Method Detail
  - getExtraData
```
public java.util.Map getExtraData()
```
    Returns the map of extra data. This map can be used to store random objects that should be available to the confirmation email template without having to extend this object.
    
    Returns:
    
    Map
  - setExtraData
```
public void setExtraData(java.util.Map pExtraData)
```
  - getOrder
```
public atg.commerce.order.Order getOrder()
```
    Returns the order associated with the confirmation
    
    Returns:
    
    Order
  - setOrder
```
public void setOrder(atg.commerce.order.Order pOrder)
```
  - getProfile
```
public atg.repository.RepositoryItem getProfile()
```
    Returns the profile associated with the confirmation
    
    Returns:
    
    RepositoryItem
  - setProfile
```
public void setProfile(atg.repository.RepositoryItem pProfile)
```
  - getToEmailAddress
```
public java.lang.String getToEmailAddress()
```
    Returns the email address associated with the confirmation
    
    Returns:
    
    RepositoryItem
  - setToEmailAddress
```
public void setToEmailAddress(java.lang.String pToEmailAddress)
```
  - getTemplateName
```
public java.lang.String getTemplateName()
```
    Returns the name of the email template to use when sending the email.
    
    Returns:
    
    the key to the email template to use when sending the confirmation
    
    See Also:
    
    CSRAgentTools.getConfirmationEmailMap()
  - setTemplateName
```
public void setTemplateName(java.lang.String pTemplateName)
```
  - isAutoConfirmationSent
```
public boolean isAutoConfirmationSent()
```
    Returns true if the automatic confirmation email was sent for this confirmation info
    
    See Also:
    
    CSRAgentTools.sendAutomaticConfirmation(ConfirmationInfo)
  - setAutoConfirmationSent
```
public void setAutoConfirmationSent(boolean pAutoConfirmationSent)
```
  - getAutoConfirmationEmailAddress
```
public java.lang.String getAutoConfirmationEmailAddress()
```
    This property is used to store the address that was used to send the auto confirmation email.
    
    See Also:
    
    CSRAgentTools.sendAutomaticConfirmation(ConfirmationInfo)
  - setAutoConfirmationEmailAddress
```
public void setAutoConfirmationEmailAddress(java.lang.String pAutoConfirmationEmailAddress)
```
  - getCustomerDisplayLocale
```
public java.util.Locale getCustomerDisplayLocale()
```
    Returns the customer's display locale which can be used to format text of the email.
    
    Returns:
    
    Locale
  - setCustomerDisplayLocale
```
public void setCustomerDisplayLocale(java.util.Locale pCustomerDisplayLocale)
```
  - getCustomerDisplayLocaleString
```
public java.lang.String getCustomerDisplayLocaleString()
```
    Returns the string value of the customer's display locale
  - reset
```
public void reset()
```
    Resets the state of this info object. This can be used for resetting the state of components of this class that are not request scoped.

Class ConfirmationInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

CONFIRMATIONINFO_PARAM_NAME

SCHEDULE_PARAM_NAME

SCHEDULED_ORDER_ITEM_PARAM_NAME

mOrder

mProfile

mExtraData

mToEmailAddress

mTemplateName

mAutoConfirmationSent

mAutoConfirmationEmailAddress

mCustomerDisplayLocale

Constructor Detail

ConfirmationInfo

Method Detail

getExtraData

setExtraData

getOrder

setOrder

getProfile

setProfile

getToEmailAddress

setToEmailAddress

getTemplateName

setTemplateName

isAutoConfirmationSent

setAutoConfirmationSent

getAutoConfirmationEmailAddress

setAutoConfirmationEmailAddress

getCustomerDisplayLocale

setCustomerDisplayLocale

getCustomerDisplayLocaleString

reset