atg.commerce.csr.returns

Class ReturnUserMessage

java.lang.Object

atg.commerce.csr.returns.ReturnUserMessage

public class ReturnUserMessage
extends java.lang.Object

This component provides user message formatting for the returns functional area

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	MSG_ERROR_AMT_REMAINING_REFUND_METHOD_NOTFOUND
static java.lang.String	MSG_ERROR_AMT_REMAINING_STORE_CREDIT_REFUND_METHOD_NOTFOUND
static java.lang.String	MSG_ERROR_GENERATING_REPLACEMENT_ORDER
static java.lang.String	MSG_ERROR_PRICING_WORKING_ORDER
static java.lang.String	MSG_ERROR_RCOITEM_NOTFOUND
static java.lang.String	MSG_ERROR_RCOSHIPPINGGROUP_NOTFOUND
static java.lang.String	MSG_ERROR_STORE_CREDIT_NOT_CREATED
static java.lang.String	MSG_ERROR_STORE_CREDIT_NOT_FOUND
static java.lang.String	MSG_ERROR_STORE_CREDIT_OWNER_PROP_NOT_FOUND
static java.lang.String	MSG_ERROR_WHILE_ADJUSTING_PAYMENT
static java.lang.String	MSG_ERROR_WHILE_COPYING_PAYMENT_GROUPS
static java.lang.String	MSG_ERROR_WHILE_RETRIEVING_APPEASEMENTS
static java.lang.String	MSG_ERROR_WHILE_UPDATING_STORE_CREDIT
static java.lang.String	MSG_ERROR_WHILE_UPDATING_STORE_CREDIT_AMOUNT
static java.lang.String	MSG_MISSING_COMPONENT
static java.lang.String	MSG_NO_ORDER_ID
static java.lang.String	MSG_NO_RECIPIENT
static java.lang.String	MSG_NO_REPLACEMENT_ORDER
static java.lang.String	MSG_NO_REPLACEMENT_ORDER_PRICE_INFO
static java.lang.String	MSG_NO_RETURN_REQUEST
static java.lang.String	MSG_PIPELINE_ERROR_APPLYING_REFUND_ALLOCATIONS
static java.lang.String	MSG_PIPELINE_ERROR_APPLYING_SELECTED_ITEMS
static java.lang.String	MSG_PIPELINE_ERROR_CALCULATING_REFUND
static java.lang.String	MSG_PIPELINE_ERROR_CONFIRMING_RETURN
static java.lang.String	MSG_PIPELINE_ERROR_CREATING_RETURNREQUEST
static java.lang.String	MSG_PIPELINE_ERROR_PREPARING_EXCHANGE_ORDER
static java.lang.String	MSG_PIPELINE_ERROR_RECEIVING_MERCHANDISE
static java.lang.String	MSG_PIPELINE_ERROR_SETTLING_RETURN
static java.lang.String	MSG_PIPELINE_ERROR_SUBMITTING_REPLACEMENT_ORDER
static java.lang.String	MSG_UNABLE_TO_LOAD_RETURN_REQUESTS
static java.lang.String	RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
ReturnUserMessage()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.String pKey, java.util.Locale pLocale) Return a String message specific for the given locale
static java.lang.String	format(java.lang.String pKey, java.lang.Object[] pParams, java.util.Locale pLocale) Format a set of parameters into a message for a given locale
static java.lang.String	format(java.lang.String pKey, java.lang.Object pParam, java.util.Locale pLocale) Format a single parameter into a message for a given locale
static java.text.MessageFormat	getFormat(java.lang.String pKey, java.util.Locale pLocale) Return a MessageFormat from the resource bundle, for the given locale
static java.util.ResourceBundle	getResourceBundle(java.util.Locale pLocale) Returns a ResourceBundle specific for the given locale
static java.lang.String	getString(java.lang.String pKey, java.util.Locale pLocale) Return a String message specific for the given locale

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

RESOURCE_BUNDLE

public static java.lang.String RESOURCE_BUNDLE

MSG_NO_ORDER_ID

public static final java.lang.String MSG_NO_ORDER_ID

See Also:

Constant Field Values

MSG_ERROR_STORE_CREDIT_NOT_CREATED

public static final java.lang.String MSG_ERROR_STORE_CREDIT_NOT_CREATED

See Also:

Constant Field Values

MSG_NO_RECIPIENT

public static final java.lang.String MSG_NO_RECIPIENT

See Also:

Constant Field Values

MSG_MISSING_COMPONENT

public static final java.lang.String MSG_MISSING_COMPONENT

See Also:

Constant Field Values

MSG_NO_RETURN_REQUEST

public static final java.lang.String MSG_NO_RETURN_REQUEST

See Also:

Constant Field Values

MSG_NO_REPLACEMENT_ORDER

public static final java.lang.String MSG_NO_REPLACEMENT_ORDER

See Also:

Constant Field Values

MSG_NO_REPLACEMENT_ORDER_PRICE_INFO

public static final java.lang.String MSG_NO_REPLACEMENT_ORDER_PRICE_INFO

See Also:

Constant Field Values

MSG_UNABLE_TO_LOAD_RETURN_REQUESTS

public static final java.lang.String MSG_UNABLE_TO_LOAD_RETURN_REQUESTS

See Also:

Constant Field Values

MSG_ERROR_WHILE_COPYING_PAYMENT_GROUPS

public static final java.lang.String MSG_ERROR_WHILE_COPYING_PAYMENT_GROUPS

See Also:

Constant Field Values

MSG_ERROR_STORE_CREDIT_NOT_FOUND

public static final java.lang.String MSG_ERROR_STORE_CREDIT_NOT_FOUND

See Also:

Constant Field Values

MSG_ERROR_STORE_CREDIT_OWNER_PROP_NOT_FOUND

public static final java.lang.String MSG_ERROR_STORE_CREDIT_OWNER_PROP_NOT_FOUND

See Also:

Constant Field Values

MSG_ERROR_WHILE_UPDATING_STORE_CREDIT

public static final java.lang.String MSG_ERROR_WHILE_UPDATING_STORE_CREDIT

See Also:

Constant Field Values

MSG_ERROR_WHILE_ADJUSTING_PAYMENT

public static final java.lang.String MSG_ERROR_WHILE_ADJUSTING_PAYMENT

See Also:

Constant Field Values

MSG_ERROR_WHILE_UPDATING_STORE_CREDIT_AMOUNT

public static final java.lang.String MSG_ERROR_WHILE_UPDATING_STORE_CREDIT_AMOUNT

See Also:

Constant Field Values

MSG_ERROR_WHILE_RETRIEVING_APPEASEMENTS

public static final java.lang.String MSG_ERROR_WHILE_RETRIEVING_APPEASEMENTS

See Also:

Constant Field Values

MSG_ERROR_PRICING_WORKING_ORDER

public static final java.lang.String MSG_ERROR_PRICING_WORKING_ORDER

See Also:

Constant Field Values

MSG_ERROR_RCOITEM_NOTFOUND

public static final java.lang.String MSG_ERROR_RCOITEM_NOTFOUND

See Also:

Constant Field Values

MSG_ERROR_RCOSHIPPINGGROUP_NOTFOUND

public static final java.lang.String MSG_ERROR_RCOSHIPPINGGROUP_NOTFOUND

See Also:

Constant Field Values

MSG_ERROR_AMT_REMAINING_REFUND_METHOD_NOTFOUND

public static final java.lang.String MSG_ERROR_AMT_REMAINING_REFUND_METHOD_NOTFOUND

See Also:

Constant Field Values

MSG_ERROR_AMT_REMAINING_STORE_CREDIT_REFUND_METHOD_NOTFOUND

public static final java.lang.String MSG_ERROR_AMT_REMAINING_STORE_CREDIT_REFUND_METHOD_NOTFOUND

See Also:

Constant Field Values

MSG_ERROR_GENERATING_REPLACEMENT_ORDER

public static final java.lang.String MSG_ERROR_GENERATING_REPLACEMENT_ORDER

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_PREPARING_EXCHANGE_ORDER

public static final java.lang.String MSG_PIPELINE_ERROR_PREPARING_EXCHANGE_ORDER

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_CREATING_RETURNREQUEST

public static final java.lang.String MSG_PIPELINE_ERROR_CREATING_RETURNREQUEST

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_SETTLING_RETURN

public static final java.lang.String MSG_PIPELINE_ERROR_SETTLING_RETURN

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_RECEIVING_MERCHANDISE

public static final java.lang.String MSG_PIPELINE_ERROR_RECEIVING_MERCHANDISE

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_CONFIRMING_RETURN

public static final java.lang.String MSG_PIPELINE_ERROR_CONFIRMING_RETURN

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_CALCULATING_REFUND

public static final java.lang.String MSG_PIPELINE_ERROR_CALCULATING_REFUND

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_APPLYING_REFUND_ALLOCATIONS

public static final java.lang.String MSG_PIPELINE_ERROR_APPLYING_REFUND_ALLOCATIONS

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_APPLYING_SELECTED_ITEMS

public static final java.lang.String MSG_PIPELINE_ERROR_APPLYING_SELECTED_ITEMS

See Also:

Constant Field Values

MSG_PIPELINE_ERROR_SUBMITTING_REPLACEMENT_ORDER

public static final java.lang.String MSG_PIPELINE_ERROR_SUBMITTING_REPLACEMENT_ORDER

See Also:

Constant Field Values

Constructor Detail

ReturnUserMessage

public ReturnUserMessage()

Method Detail

format

public static java.lang.String format(java.lang.String pKey,
                                      java.lang.Object pParam,
                                      java.util.Locale pLocale)

Format a single parameter into a message for a given locale

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pParam - a single parameter to use in formatting

pLocale - the locale of the user

Returns:

the localized and formatted message

format

public static java.lang.String format(java.lang.String pKey,
                                      java.util.Locale pLocale)

Return a String message specific for the given locale

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pLocale - the locale of the user

Returns:

the localized message

format

public static java.lang.String format(java.lang.String pKey,
                                      java.lang.Object[] pParams,
                                      java.util.Locale pLocale)

Format a set of parameters into a message for a given locale

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pParams - a set of parameters to use in the formatting

pLocale - the locale of the user

Returns:

the localized and formatted message

getFormat

public static java.text.MessageFormat getFormat(java.lang.String pKey,
                                                java.util.Locale pLocale)

Return a MessageFormat from the resource bundle, for the given locale

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pLocale - the locale of the user

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.util.Locale pLocale)
                                                  throws java.util.MissingResourceException

Returns a ResourceBundle specific for the given locale

Parameters:

pLocale - the locale of the user

Throws:

java.util.MissingResourceException

getString

public static java.lang.String getString(java.lang.String pKey,
                                         java.util.Locale pLocale)

Return a String message specific for the given locale

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pLocale - the locale of the user

Returns:

the localized string