atg.commerce.csr.returns

Class RefundMethod

java.lang.Object

atg.commerce.order.Refund

atg.commerce.csr.returns.RefundMethod

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CreditCardRefundMethod

public class RefundMethod
extends atg.commerce.order.Refund
implements java.io.Serializable

This class represents information for a refund for returns

This class extends the base classRefund. Out of box, the returns feature supports only CreditCardRefundMethod and StoreCreditRefundMethod. If you want to support additional payment type as refund option, you need to extend this class.

The loadRefundMethod(RepositoryItem, Order) is used to load refund method properties from repository item. if you add additional properties to refund method and it needs to be loaded to the refund method object, you need to extend this method.

The saveRefundMethod(MutableRepositoryItem) is used to save refund method properties to repository item. if you add additional properties to refund method and it needs to be saved in the repository, you need to extend this method.

This class is used by returns only and is deprecated now and the class Refund should be used instead.

See Also:

loadRefundMethod(RepositoryItem, Order), saveRefundMethod(MutableRepositoryItem), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CREDIT_CARD_TYPE
static java.lang.String	RETURN_MANAGER_PATH
static java.lang.String	STORE_CREDIT_TYPE

Fields inherited from class atg.commerce.order.Refund

mAmount, mMaximumRefundAmount, mRefundType, NO_LIMIT, UNKNOWN_TYPE

Constructor Summary

Constructors

Constructor and Description
RefundMethod() Deprecated.
RefundMethod(java.lang.String pRefundType) Construct this object, setting the refund type
RefundMethod(java.lang.String pRefundType, double pAmount) Construct this object, setting the refund type and amount

Method Summary

Modifier and Type	Method and Description
static RefundMethod	getInstance() Deprecated.
ReturnManager	getReturnManager() Deprecated.
void	loadRefundMethod(RepositoryItem pSource, Order pOrder) This method is used to copy the information from the source refund method repository item to refund method instance.
void	saveRefundMethod(MutableRepositoryItem pDestination) This method is used to copy the information from refund method instance to repository item.

Methods inherited from class atg.commerce.order.Refund

getAmount, getMaximumRefundAmount, getRefundType, loadRefund, saveRefund, setAmount, setMaximumRefundAmount, setRefundType

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

RETURN_MANAGER_PATH

public static final java.lang.String RETURN_MANAGER_PATH

See Also:

Constant Field Values

CREDIT_CARD_TYPE

public static final java.lang.String CREDIT_CARD_TYPE

See Also:

Constant Field Values

STORE_CREDIT_TYPE

public static final java.lang.String STORE_CREDIT_TYPE

See Also:

Constant Field Values

Constructor Detail

RefundMethod

public RefundMethod()

Deprecated.

Construct this object, setting the refund type There is a sub-class for the Store credits.

RefundMethod

public RefundMethod(java.lang.String pRefundType)

Construct this object, setting the refund type

RefundMethod

public RefundMethod(java.lang.String pRefundType,
                    double pAmount)

Construct this object, setting the refund type and amount

Method Detail

getReturnManager

public ReturnManager getReturnManager()

Deprecated.

This method gets the http request and resolves the ReturnManager.
This method only works with the http request. If the http request is null,
then this method returns null.

Returns:

ReturnManager

getInstance

public static RefundMethod getInstance()

Deprecated.

This method calls RefundMethod() to create
instance of RefundMethod.

Returns:

RefundMethod

loadRefundMethod

public void loadRefundMethod(RepositoryItem pSource,
                             Order pOrder)
                      throws ReturnException

This method is used to copy the information from the source refund method repository item to refund method instance.

This method sets the amount property.

Parameters:

pOrder -

pSource - The information to be copied from.

Throws:

ReturnException

saveRefundMethod

public void saveRefundMethod(MutableRepositoryItem pDestination)
                      throws ReturnException

This method is used to copy the information from refund method instance to repository item.

This method sets the ReturnTools.getAmountPropertyName() in the repository item.

Parameters:

pDestination - The information to be copied

Throws:

ReturnException