atg.commerce.pricing.result

Class PriceAdjustment

java.lang.Object

atg.commerce.pricing.result.PriceAdjustment

public class PriceAdjustment
extends java.lang.Object

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:

• description: a description of the adjustment that this object recorded
• pricingModelId: the id of pricing model which adjusted the price, if there was one
• 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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PriceAdjustment() Constructors
PriceAdjustment(java.lang.String pDescription, java.lang.String pPricingModelId, double pTotalAdjustment, double pQuantityWithFractionAdjusted)
PriceAdjustment(java.lang.String pDescription, java.lang.String pPricingModelId, double pTotalAdjustment, long pQuantityAdjusted)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get property Description
java.lang.String	getPricingModelId() The pricing model that caused this price adjustment
long	getQuantityAdjusted() Get property QuantityAdjusted
double	getQuantityAdjustedDerivedAsFloatingPoint() Get derived quantity property QuantityWithFractionAdjusted, representing first non-zero value from getQuantityWithFractionAdjusted, getQuantityAdjusted
double	getQuantityWithFractionAdjusted() Get property QuantityWithFractionAdjusted
double	getTotalAdjustment() The total price adjustment
void	setDescription(java.lang.String pDescription) Set property Description
void	setPricingModelId(java.lang.String pPricingModelId)
void	setQuantityAdjusted(long pQuantityAdjusted) Set property QuantityAdjusted
void	setQuantityWithFractionAdjusted(double pQuantityWithFractionAdjusted) Set property QuantityWithFractionAdjusted
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

PriceAdjustment

public PriceAdjustment()

Constructors

PriceAdjustment

public PriceAdjustment(java.lang.String pDescription,
                       java.lang.String pPricingModelId,
                       double pTotalAdjustment,
                       long pQuantityAdjusted)

PriceAdjustment

public PriceAdjustment(java.lang.String pDescription,
                       java.lang.String pPricingModelId,
                       double pTotalAdjustment,
                       double pQuantityWithFractionAdjusted)

Method Detail

setDescription

public void setDescription(java.lang.String pDescription)

Set property Description

Parameters:

pDescription - new value to set

getDescription

public java.lang.String getDescription()

Get property Description

Returns:

Description

setPricingModelId

public void setPricingModelId(java.lang.String pPricingModelId)

getPricingModelId

public java.lang.String getPricingModelId()

The pricing model that caused this 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)

Set property QuantityWithFractionAdjusted

Parameters:

pQuantityWithFractionAdjusted - new value to set

getQuantityWithFractionAdjusted

public double getQuantityWithFractionAdjusted()

Get property QuantityWithFractionAdjusted

Returns:

QuantityAdjusted

getQuantityAdjustedDerivedAsFloatingPoint

public double getQuantityAdjustedDerivedAsFloatingPoint()

Get derived quantity property QuantityWithFractionAdjusted, representing first non-zero value from getQuantityWithFractionAdjusted, getQuantityAdjusted

Returns:

QuantityAdjustedDerivedAsFloatingPoint

toString

public java.lang.String toString()

Object override

Overrides:

toString in class java.lang.Object