atg.commerce.csr.returns
Class ItemCostAdjustment

java.lang.Object
  atg.commerce.csr.returns.ItemCostAdjustment

All Implemented Interfaces:

java.io.Serializable

public class ItemCostAdjustment
extends java.lang.Object
implements java.io.Serializable

Details the adjustments made to the cost of an item/shipping group relationship.

Objects of this type are generated during an return or exchange and detail the cost adjustments to the items.

These adjustment objects are summed to determine the refund values.

The following are the adjustment properties:

amountAdjustment

the adjustment to the item's amount. This value includes difference caused by item level promotions

order discount share

the adjustment to the item's amount order discount share

manual adjustment share

the adjustment to the item's manual adjustment share

tax share

the adjustment to the item's tax share

shipping cost share

the adjustment to the item's shipping cost share.

See Also:

ReturnTools.createItemCostAdjustment(), Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected double	mAmountAdjustment
protected java.lang.String	mCommerceItemId
protected double	mManualAdjustmentShareAdjustment
protected double	mOrderDiscountShareAdjustment
protected long	mQuantityAdjusted
protected java.lang.String	mShippingGroupId
protected double	mShippingShareAdjustment
protected double	mTaxShareAdjustment

Constructor Summary

ItemCostAdjustment()

Method Summary

boolean	containsAdjustments() Returns true if this object contains any adjustments.
double	getAmountAdjustment()
java.lang.String	getCommerceItemId()
double	getManualAdjustmentShareAdjustment()
double	getOrderDiscountShareAdjustment()
long	getQuantityAdjusted()
java.lang.String	getShippingGroupId()
double	getShippingShareAdjustment()
double	getTaxShareAdjustment()
void	setAmountAdjustment(double pAmountAdjustment)
void	setCommerceItemId(java.lang.String pCommerceItemId)
void	setManualAdjustmentShareAdjustment(double pManualAdjustmentShareAdjustment)
void	setOrderDiscountShareAdjustment(double pOrderDiscountShareAdjustment)
void	setQuantityAdjusted(long pQuantityAdjusted)
void	setShippingGroupId(java.lang.String pShippingGroupId)
void	setShippingShareAdjustment(double pShippingShareAdjustment)
void	setTaxShareAdjustment(double pTaxShareAdjustment)
java.lang.String	toString() Produces a String representation for this ItemAdjustment

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mQuantityAdjusted

protected long mQuantityAdjusted

mAmountAdjustment

protected double mAmountAdjustment

mOrderDiscountShareAdjustment

protected double mOrderDiscountShareAdjustment

mShippingShareAdjustment

protected double mShippingShareAdjustment

mTaxShareAdjustment

protected double mTaxShareAdjustment

mManualAdjustmentShareAdjustment

protected double mManualAdjustmentShareAdjustment

mCommerceItemId

protected java.lang.String mCommerceItemId

mShippingGroupId

protected java.lang.String mShippingGroupId

Constructor Detail

ItemCostAdjustment

public ItemCostAdjustment()

Method Detail

getQuantityAdjusted

public long getQuantityAdjusted()

Returns:

the quantity of the item to which this adjustment applies.

setQuantityAdjusted

public void setQuantityAdjusted(long pQuantityAdjusted)

getAmountAdjustment

public double getAmountAdjustment()

Returns:

the adjustment to the value of the item's amount

setAmountAdjustment

public void setAmountAdjustment(double pAmountAdjustment)

getOrderDiscountShareAdjustment

public double getOrderDiscountShareAdjustment()

Returns:

the adjustment to the value of the item's order discount share

setOrderDiscountShareAdjustment

public void setOrderDiscountShareAdjustment(double pOrderDiscountShareAdjustment)

getShippingShareAdjustment

public double getShippingShareAdjustment()

Returns:

the adjustment to the value of the item's shipping share

setShippingShareAdjustment

public void setShippingShareAdjustment(double pShippingShareAdjustment)

getTaxShareAdjustment

public double getTaxShareAdjustment()

Returns:

the adjustment to the value of the item's tax

setTaxShareAdjustment

public void setTaxShareAdjustment(double pTaxShareAdjustment)

getManualAdjustmentShareAdjustment

public double getManualAdjustmentShareAdjustment()

Returns:

the adjustment to the value of the item's manual adjustment share

setManualAdjustmentShareAdjustment

public void setManualAdjustmentShareAdjustment(double pManualAdjustmentShareAdjustment)

getCommerceItemId

public java.lang.String getCommerceItemId()

Returns:

the commerce item id to which this adjustment object applies

setCommerceItemId

public void setCommerceItemId(java.lang.String pCommerceItemId)

getShippingGroupId

public java.lang.String getShippingGroupId()

Returns:

the shipping group id to which this adjustment object applies

setShippingGroupId

public void setShippingGroupId(java.lang.String pShippingGroupId)

containsAdjustments

public boolean containsAdjustments()

Returns true if this object contains any adjustments.

toString

public java.lang.String toString()

Produces a String representation for this ItemAdjustment

Overrides:

toString in class java.lang.Object

Returns:

a String representation for this ItemAdjustment