public class AmountInfo
extends java.lang.Object
implements java.io.Serializable
Properties
PricingAdjustment
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
FINAL_PRICE_MANUAL_ADJUSTMENT
finalReasonCode for a manually adjusted final price
|
protected java.lang.String |
mFinalReasonCode |
Constructor and Description |
---|
AmountInfo() |
Modifier and Type | Method and Description |
---|---|
java.util.List |
getAdjustments()
A list of PricingAdjustment objects which record an audit trail of changes that
have happened to the amount in this AmountInfo
|
double |
getAmount()
the raw number about which this AmountInfo stores interpretive information
|
java.util.List |
getClosenessQualifiers()
A list of closenessQualifiers that this order/item satisfies.
|
java.lang.String |
getCurrencyCode()
the currency code for the price that this AmountInfo represents
|
java.lang.String |
getFinalReasonCode()
the reason for the item being marked with a final price
|
boolean |
isAmountIsFinal()
If this flag is true, this amount info should never be changed.
|
boolean |
isDiscounted()
Test property Discounted
|
void |
markAsFinal()
This method will mark this AmountInfo as final.
|
void |
markAsFinal(java.lang.String pDescription)
This method will mark this AmountInfo as final.
|
void |
markAsFinal(java.lang.String pDescription,
java.lang.String pReasonCode,
long pQuantityAdjusted,
double pAmount,
boolean pClearAdjustments)
Marks the price info as final.
|
void |
markAsFinal(java.lang.String pDescription,
java.lang.String pReasonCode,
long pQuantityAdjusted,
double pQuantityWithFractionAdjusted,
double pAmount,
boolean pClearAdjustments)
Marks the price info as final.
|
void |
setAmount(double pAmount)
the raw number about which this AmountInfo stores interpretive information
|
void |
setAmountIsFinal(boolean pAmountIsFinal)
If true, this amountInfo will not be recalculated
If you want a PricingAdjustment to be created that
reflects this change, then use
markAsFinal
instead. |
void |
setClosenessQualifiers(java.util.List pClosenessQualifiers)
A list of closenessQualifiers that this order/item satisfies.
|
void |
setCurrencyCode(java.lang.String pCurrencyCode)
the currency code for the price that this AmountInfo represents
|
void |
setDiscounted(boolean pDiscounted)
Flag that states whether or not this AmountInfo has been discounted
|
void |
setFinalReasonCode(java.lang.String pFinalReasonCode)
the reason for the item being marked with a final price
|
java.lang.String |
toString()
Produces a String representation for this AmountInfo
|
void |
unmarkAsFinal()
Removes a final designation and sets the final reason code to null.
|
public static java.lang.String CLASS_VERSION
public static final java.lang.String FINAL_PRICE_MANUAL_ADJUSTMENT
protected java.lang.String mFinalReasonCode
public void setCurrencyCode(java.lang.String pCurrencyCode)
pCurrencyCode
- new value to setpublic java.lang.String getCurrencyCode()
public void setAmount(double pAmount)
pAmount
- new value to setpublic double getAmount()
public void setDiscounted(boolean pDiscounted)
pDiscounted
- new value to setpublic boolean isDiscounted()
public java.util.List getAdjustments()
public void setAmountIsFinal(boolean pAmountIsFinal)
markAsFinal
instead.pAmountIsFinal
- the new valuepublic boolean isAmountIsFinal()
public void setClosenessQualifiers(java.util.List pClosenessQualifiers)
pClosenessQualifiers
- the new valuepublic java.util.List getClosenessQualifiers()
public void unmarkAsFinal()
public void markAsFinal()
public void markAsFinal(java.lang.String pDescription)
pDescription
- A string that explains why the AmountInfo was marked final.markAsFinal(String, String, long, double, boolean)
public void markAsFinal(java.lang.String pDescription, java.lang.String pReasonCode, long pQuantityAdjusted, double pAmount, boolean pClearAdjustments)
pDescription
- the free form description for the final price. This description is used by the PriceAdjustment
added to the price infopReasonCode
- the reason code for the final pricepQuantityAdjusted
- to total quantity being adjustedpAmount
- the new amountpClearAdjustments
- determines the List of PriceAdjustments are cleared prior to adding
a new PriceAdjustment for the final price.public void markAsFinal(java.lang.String pDescription, java.lang.String pReasonCode, long pQuantityAdjusted, double pQuantityWithFractionAdjusted, double pAmount, boolean pClearAdjustments)
pDescription
- the free form description for the final price. This description is used by the PriceAdjustment
added to the price infopReasonCode
- the reason code for the final pricepQuantityAdjusted
- to total quantity being adjustedpQuantityWithFractionAdjusted
- to total quantity (fractional) being adjustedpAmount
- the new amountpClearAdjustments
- determines the List of PriceAdjustments are cleared prior to adding
a new PriceAdjustment for the final price.public void setFinalReasonCode(java.lang.String pFinalReasonCode)
pFinalReasonCode
- new value to setpublic java.lang.String getFinalReasonCode()
public java.lang.String toString()
toString
in class java.lang.Object