atg.commerce.pricing

Class PricingAdjustment

java.lang.Object

atg.commerce.pricing.PricingAdjustment

All Implemented Interfaces:

java.io.Serializable

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

Represents an element of a price's audit trail. A chain of these objects represents all of the changes that a price has undergone. This is useful in examining how a price was calculated. These appear in the AmountInfo's adjustments list. Properties:

• adjustmentDescription: a description of the adjustment that this object recorded
• pricingModel: the pricing model which adjusted the price, if there was one
• adjustment: the unit adjustment. That is to say, the price adjustment per quantity of one object whose price is being adjusted.
• totalAdjustment: the total adjustment. This is how much the price changed.
• quantityAdjusted: the quantity of the object whose price was adjusted.

Note: a unit adjustment amount is just the total adjustment divided by the quantity

See Also:

AmountInfo, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PricingAdjustment() Constructors
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, double pQuantityWithFractionAdjusted)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, double pQuantityWithFractionAdjusted, java.lang.Integer pPricingModelIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, double pQuantityWithFractionAdjusted, java.lang.Integer pPricingModelIndex, java.lang.Integer pPricingModelGroupIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, double pQuantityWithFractionAdjusted, RepositoryItem pCoupon)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, double pQuantityWithFractionAdjusted)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, double pQuantityWithFractionAdjusted, java.lang.Integer pPricingModelIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, double pQuantityWithFractionAdjusted, java.lang.Integer pPricingModelIndex, java.lang.Integer pPricingModelGroupIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, java.lang.Integer pPricingModelIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, java.lang.Integer pPricingModelIndex, java.lang.Integer pPricingModelGroupIndex)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, double pTotalAdjustment, long pQuantityAdjusted, RepositoryItem pCoupon)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, RepositoryItem pManualPricingAdjustment, double pTotalAdjustment, double pQuantityWithFractionAdjusted)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, RepositoryItem pManualPricingAdjustment, double pTotalAdjustment, double pQuantityWithFractionAdjusted, RepositoryItem pCoupon)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, RepositoryItem pManualPricingAdjustment, double pTotalAdjustment, long pQuantityAdjusted)
PricingAdjustment(java.lang.String pAdjustmentDescription, RepositoryItem pPricingModel, RepositoryItem pManualPricingAdjustment, double pTotalAdjustment, long pQuantityAdjusted, RepositoryItem pCoupon)

Method Summary

Modifier and Type	Method and Description
double	getAdjustment() The unit price adjustment
java.lang.String	getAdjustmentDescription() Get property AdjustmentDescription
RepositoryItem	getCoupon() The Coupon claimed that caused the pricing model to be granted
RepositoryItem	getManualPricingAdjustment() The manual pricing adjustment that caused this price adjustment
RepositoryItem	getPricingModel() The pricing model that caused this price adjustment
java.lang.Integer	getPricingModelGroupIndex() Gets the PricingModelGroupIndex property
java.lang.Integer	getPricingModelIndex() Get property PricingModelIndex
long	getQuantityAdjusted() Get property QuantityAdjusted
double	getQuantityAdjustedDerivedAsFloatingPoint() This method will return a derived quantity value that this adjustment affected.
double	getQuantityWithFractionAdjusted() Returns the quantity with fraction that this adjustment affected.
java.lang.Integer	getQuoteInfoIndex() Gets the QuoteInfoIndex property
double	getTotalAdjustment() The total price adjustment
void	setAdjustment(double pAdjustment) Deprecated.
void	setAdjustmentDescription(java.lang.String pAdjustmentDescription) Set property AdjustmentDescription
void	setCoupon(RepositoryItem pCoupon)
void	setManualPricingAdjustment(RepositoryItem pManualPricingAdjustment)
void	setPricingModel(RepositoryItem pPricingModel)
void	setPricingModelGroupIndex(java.lang.Integer pPricingModelGroupIndex) Sets the PricingModelGroupIndex property
void	setPricingModelIndex(java.lang.Integer pPricingModelIndex) Set property PricingModelIndex.
void	setQuantityAdjusted(long pQuantityAdjusted) Set property QuantityAdjusted
void	setQuantityWithFractionAdjusted(double pQuantityWithFractionAdjusted) Sets the quantity with fraction that this adjustment affected.
void	setQuoteInfoIndex(java.lang.Integer pQuoteInfoIndex) Sets the QuoteInfoIndex property
void	setTotalAdjustment(double pTotalAdjustment)
java.lang.String	toString() Object override

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

Constructor Detail

PricingAdjustment

public PricingAdjustment()

Constructors

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         double pQuantityWithFractionAdjusted)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         RepositoryItem pCoupon)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted,
                         RepositoryItem pCoupon)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         RepositoryItem pManualPricingAdjustment,
                         double pTotalAdjustment,
                         long pQuantityAdjusted)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         RepositoryItem pManualPricingAdjustment,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         RepositoryItem pManualPricingAdjustment,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         RepositoryItem pCoupon)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         RepositoryItem pManualPricingAdjustment,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted,
                         RepositoryItem pCoupon)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         java.lang.Integer pPricingModelIndex)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted,
                         java.lang.Integer pPricingModelIndex)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         double pQuantityWithFractionAdjusted,
                         java.lang.Integer pPricingModelIndex)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         java.lang.Integer pPricingModelIndex,
                         java.lang.Integer pPricingModelGroupIndex)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         double pQuantityWithFractionAdjusted,
                         java.lang.Integer pPricingModelIndex,
                         java.lang.Integer pPricingModelGroupIndex)

PricingAdjustment

public PricingAdjustment(java.lang.String pAdjustmentDescription,
                         RepositoryItem pPricingModel,
                         double pTotalAdjustment,
                         long pQuantityAdjusted,
                         double pQuantityWithFractionAdjusted,
                         java.lang.Integer pPricingModelIndex,
                         java.lang.Integer pPricingModelGroupIndex)

Method Detail

setAdjustmentDescription

public void setAdjustmentDescription(java.lang.String pAdjustmentDescription)

Set property AdjustmentDescription

Parameters:

pAdjustmentDescription - new value to set

getAdjustmentDescription

public java.lang.String getAdjustmentDescription()

Get property AdjustmentDescription

Returns:

AdjustmentDescription

setPricingModel

public void setPricingModel(RepositoryItem pPricingModel)

getPricingModel

public RepositoryItem getPricingModel()

The pricing model that caused this price adjustment

setCoupon

public void setCoupon(RepositoryItem pCoupon)

getCoupon

public RepositoryItem getCoupon()

The Coupon claimed that caused the pricing model to be granted

setManualPricingAdjustment

public void setManualPricingAdjustment(RepositoryItem pManualPricingAdjustment)

getManualPricingAdjustment

public RepositoryItem getManualPricingAdjustment()

The manual pricing adjustment that caused this price adjustment

setAdjustment

public void setAdjustment(double pAdjustment)

Deprecated.

Set the unit price adjustment. This will actually set the total adjustment.

getAdjustment

public double getAdjustment()

The unit price adjustment

setTotalAdjustment

public void setTotalAdjustment(double pTotalAdjustment)

getTotalAdjustment

public double getTotalAdjustment()

The total price adjustment

setQuantityAdjusted

public void setQuantityAdjusted(long pQuantityAdjusted)

Set property QuantityAdjusted

Parameters:

pQuantityAdjusted - new value to set

getQuantityAdjusted

public long getQuantityAdjusted()

Get property QuantityAdjusted

Returns:

QuantityAdjusted

setQuantityWithFractionAdjusted

public void setQuantityWithFractionAdjusted(double pQuantityWithFractionAdjusted)

Sets the quantity with fraction that this adjustment affected.

Parameters:

pQuantityWithFractionAdjusted - represents the fractional quantity that this adjustment affected.

getQuantityWithFractionAdjusted

public double getQuantityWithFractionAdjusted()

Returns the quantity with fraction that this adjustment affected.

Returns:

mQuantityWithFractionAdjusted a double value.

getQuantityAdjustedDerivedAsFloatingPoint

public double getQuantityAdjustedDerivedAsFloatingPoint()

This method will return a derived quantity value that this adjustment affected.

It will decide upon the correct quantity adjustment value to return, returning the first non zero value from the properties, QuantityAdjustedWithFraction, QuantityAdjusted, in that order.

The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (QuantityAdjustedWithFraction or QuantityAdjusted holds the value.

Returns:

a derived quantity that this adjustment affected.

setPricingModelIndex

public void setPricingModelIndex(java.lang.Integer pPricingModelIndex)

Set property PricingModelIndex.

Parameters:

pPricingModelIndex - index for the pricing model

getPricingModelIndex

public java.lang.Integer getPricingModelIndex()

Get property PricingModelIndex

Returns:

index for the pricing model

getPricingModelGroupIndex

public java.lang.Integer getPricingModelGroupIndex()

Gets the PricingModelGroupIndex property

Returns:

pricingModelGroupIndex property

setPricingModelGroupIndex

public void setPricingModelGroupIndex(java.lang.Integer pPricingModelGroupIndex)

Sets the PricingModelGroupIndex property

Parameters:

pPricingModelGroupIndex - group index for the pricing model

getQuoteInfoIndex

public java.lang.Integer getQuoteInfoIndex()

Gets the QuoteInfoIndex property

Returns:

QuoteInfoIndex property

setQuoteInfoIndex

public void setQuoteInfoIndex(java.lang.Integer pQuoteInfoIndex)

Sets the QuoteInfoIndex property

Parameters:

pQuoteInfoIndex - quote info index for the pricing adjustment

toString

public java.lang.String toString()

Object override

Overrides:

toString in class java.lang.Object