Object
Serializable
The Quote class provides a framework for building a price quote for a collection of LineItems. The LineItems may be adjusted within the framework such that any sub-quantity of a LineItem maybe assigned a new unit price. Each LineAdjustment represents a subquantity of a LineItem and include a new unit price. Each LineAdjustment must have exactly one AdjustmentDetail object describing the adjustment. The quantities of a set of LineAdjustments for a LineItem may not exceed the quantity of the LineItem. The subtotal of the quote is the sum of the values of the LineItems. OrderAdjustments may also be added to the Quote. The OrderAdjustments change the total for the Quote. The total is computed by adding any OrderAdjustments to the subtotal for the object.
Related Topics
LineItem
LineAdjustment
OrderAdjustment
AdjustmentDetail
AdjustmentType
QuoteFactory
Money
Object
Quote
Serializable
Field Summary |
public static final |
|
public static final double |
|
public static final double |
|
public static final |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final |
|
public static final |
|
public static final |
|
public static final |
|
public static final |
|
public static final |
|
Constructor Summary |
|
|
Method Summary |
public void |
|
public void |
|
public void |
|
public static final boolean |
|
public final |
|
public final |
|
public final |
|
public final int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public final |
|
public final |
|
public |
|
public final int |
|
public static final |
|
public static final double | |
public static final double |
|
public void |
|
public final void |
|
public final |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String
INPUT
public static final double MIN_PRICE
public static final double ONE_HUNDRED
public static final String
STATE
public static final int STATE_I_DISC
public static final int STATE_I_END
public static final int STATE_I_ERROR
public static final int STATE_I_NO_ADJ
public static final int STATE_I_SHIPPING
public static final int STATE_I_TAX
public static final String
STATE_S_DISC
public static final String
STATE_S_END
public static final String
STATE_S_ERROR
public static final String
STATE_S_NO_ADJ
public static final String
STATE_S_SHIPPING
public static final String
STATE_S_TAX
Constructor Detail |
public Quote()
public Quote(QuoteFactory
factory,List
lineItems)
Related Topics
Method Detail |
public void addLineAdjustment(Add a new LineAdjustment based on the specified input values and with the specified AdjustmentDetail.LineItem
item, int qty,AdjustmentDetail
aDetail)
throwsQuoteException
QuoteException
Related Topics
LineAdjustment
LineItem
AdjustmentDetail
public void addLineAdjustment(int itemNumber, int qty,Add a new LineAdjustment based on the specified input values and with the specified AdjustmentDetail.AdjustmentDetail
aDetail)
throwsQuoteException
QuoteException
Related Topics
LineAdjustment
LineItem
AdjustmentDetail
public void addOrderDetail(Create a new OrderAdjustment object with the specified AdjustmentDetail object. Add the newly created OrderAdjustment to the list of adjustments. Adding of OrderAdjustments effects the total price for the Quote but does not effect the subtotal of the Quote. OrderAdjustments must be added after all LineAdjustments have been added and before shipping adjustments are added. Failure to follow this order will cause a QuoteException to be thrown.AdjustmentDetail
aDetail)
throwsQuoteException
QuoteException
Related Topics
AdjustmentDetail
OrderAdjustment
LineAdjustment
public static final boolean checkMinPrice(Money
value)
Returns true if the Money value is greater than or equal to the
minimum price of zero.
public final Money
getBaseShipping()
Returns the Money value for the base shipping cost.
If the base shipping cost has not been explicitly
set with the setShippingbase() mehtod
the Money object returned will have a value of zero
and the currency will match the currency of the Quote
object
Related Topics
public final String
getCurrency()
Returns the currency for this Quote object. The
value is derived from the LineItems used to construct
or set the Quote.
Related Topics
public final QuoteFactory
getFactory()
Get the QuoteFactory used to create other Quote package
objects as needed by this Quote object.
Related Topics
public final int getLineCnt()Return the number of LineItems in this Quote.
public LineItem
getLineItem(int itemNumber)
Returns the LineItem associated with the index
supplied.
Related Topics
public List
getLineItems()
Returns an unmodifiable List of the LineItem objects
of this object.
Related Topics
public List
getOrderAdjustments()
Returns the full list of OrderAdjustment objects associated
with this Quote. The full list of adjustments includes order
discounts and shipping adjustments.
Use getOrderDiscountAdjustments() to obtain only the order
discounts and use getShippingOrderAdjustments() to obtain
shipping adjustments.
Related Topics
OrderAdjustment
AdjustmentType
public List
getOrderDiscountAdjustments()
Returns only the list of order discount adjustments from
the list of OrderAdjustments.
Use getOrderAdjustments() to obtain all the order
OrderAdjustment objects and use getShippingOrderAdjustments()
to obtain just the shipping adjustments.
All of the OrderAdjustment objects returned will have an
AdjustmentType of AdjustmentType.ORDER_DISCOUNT.
Related Topics
OrderAdjustment
AdjustmentType
public List
getShippingOrderAdjustments()
Returns only the list of shipping adjustments from
the list of OrderAdjustments.
Use getOrderAdjustments() to obtain all the order
OrderAdjustment objects and use getOrderDiscountAdjustments()
to obtain just the order discount adjustments.
All of the OrderAdjustment objects returned will have an
AdjustmentType of AdjustmentType.SHIPPING_BASE_PRICE.
Related Topics
OrderAdjustment
AdjustmentType
public final Money
getSubtotal()
Returns the current subtotal of the Quote. The subtotal
is the sum of the total values of the LineItems.
After any order adjustments are added the subtotal will not change.
Related Topics
public final Money
getTotal()
Returns the current total of the Quote. The total
is the subtotal plus all order adjustments.
Related Topics
public String
getUID()
Return the unique string identifier for this Quote
public final int incrementSeqNumber()Used to order and associate adjustments made to the Quote object. The user of the object should use this method to increment the sequence number. The incremented sequence number will then be used to decorate all adjustments until the number is incremented again. The first call to this method after constructing or setting this object will return 0.
public static finalRounds the amount of the MutableMoney specified to two digits and returns the modified MutableMoneyMutableMoney
round(MutableMoney
value)
public static final double round(Money
value)
Returns a new double that is equivalent to
the amount of Money specified rounded to two digits
to the right of the decimal point.
public static final double round(double value)Returns a new double that is equivalent to the value specified rounded to two digits to the right of the decimal point.
public void set(Use this method to reinitialize a Quote object for reuse. After calling this method the Quote object will represent the new line items and factory specified and will have no line or order adjustments.QuoteFactory
factory,List
lineItems)
throwsQuoteException
,CurrencyMismatchException
QuoteException
CurrencyMismatchException
Related Topics
public final void setBaseShipping(Sets the base shipping cost for the Quote.Money
shippingBase)
throwsQuoteException
,CurrencyMismatchException
QuoteException
CurrencyMismatchException
Related Topics
public final String
toString()
Provides a view of the current state of the object.
This method is intended for debugging and may change at
anytime.
Object.toString()