atg.commerce.pricing.result
Class ShippingPrice

java.lang.Object
  atg.commerce.pricing.result.ShippingPrice

public class ShippingPrice
extends java.lang.Object

Contains the following information about the shipping costs of a ShippingGroup:

• shippingGroupId, the ID of the shipping group
• amount, the total cost to ship the items in this group
• discounted, boolean indicating if any items in this group have been discounted
• rawShipping, the shipping costs before any discounts
• subtotal, the subtotal of the items in this shipping group
• taxableSubtotal, the taxable subtotal of the items in this shipping group
• nonTaxableSubtotal, the nontaxable subtotal of the items in this shipping group
• tax, the total tax on all items in this shipping group

  Field Summary

  static java.lang.String

  CLASS_VERSION Class version string

  Constructor Summary

  ShippingPrice()
  

  Method Summary

  PriceAdjustment[]	getAdjustments() the discounts of all items in this shipping group
  double	getAmount() the cost to ship all items in this group
  ShippingPriceSubtotal	getNonTaxableSubtotal() the nontaxable subtotal of all items in this shipping group
  double	getRawShipping() the cost of shipping before any discounts
  java.lang.String	getShippingGroupId() the shipping group id
  ShippingPriceSubtotal	getSubtotal() the subtotal of all items in this shipping group
  TaxPrice	getTax() the total tax of all items in this shipping group
  ShippingPriceSubtotal	getTaxableSubtotal() the taxable subtotal of all items in this shipping group
  boolean	isDiscounted() boolean indicating if any items in this group have been discounted
  void	setAdjustments(PriceAdjustment[] pAdjustments) the discounts of all items in this shipping group
  void	setAmount(double pAmount) the cost to ship all items in this group
  void	setDiscounted(boolean pDiscounted) boolean indicating if any items in this group have been discounted
  void	setNonTaxableSubtotal(ShippingPriceSubtotal pNonTaxableSubtotal) the nontaxable subtotal of all items in this shipping group
  void	setRawShipping(double pRawShipping) the cost of shipping before any discounts
  void	setShippingGroupId(java.lang.String pShippingGroupId) the shipping group id
  void	setSubtotal(ShippingPriceSubtotal pSubtotal) the subtotal of all items in this shipping group
  void	setTax(TaxPrice pTax) the total tax of all items in this shipping group
  void	setTaxableSubtotal(ShippingPriceSubtotal pTaxableSubtotal) the taxable subtotal of all items in this shipping group
  java.lang.String	toString() Returns a string form of this price information

  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

  ShippingPrice

  public ShippingPrice()

  Method Detail

  setShippingGroupId

  public void setShippingGroupId(java.lang.String pShippingGroupId)

  the shipping group id

  Parameters:

  pShippingGroupId - new value to set

  getShippingGroupId

  public java.lang.String getShippingGroupId()

  the shipping group id

  Returns:

  property ShippingGroupId

  setAmount

  public void setAmount(double pAmount)

  the cost to ship all items in this group

  Parameters:

  pAmount - new value to set

  getAmount

  public double getAmount()

  the cost to ship all items in this group

  Returns:

  property Amount

  setDiscounted

  public void setDiscounted(boolean pDiscounted)

  boolean indicating if any items in this group have been discounted

  Parameters:

  pDiscounted - new value to set

  isDiscounted

  public boolean isDiscounted()

  boolean indicating if any items in this group have been discounted

  Returns:

  property Discounted

  setRawShipping

  public void setRawShipping(double pRawShipping)

  the cost of shipping before any discounts

  Parameters:

  pRawShipping - new value to set

  getRawShipping

  public double getRawShipping()

  the cost of shipping before any discounts

  Returns:

  property RawShipping

  setSubtotal

  public void setSubtotal(ShippingPriceSubtotal pSubtotal)

  the subtotal of all items in this shipping group

  Parameters:

  pSubtotal - new value to set

  getSubtotal

  public ShippingPriceSubtotal getSubtotal()

  the subtotal of all items in this shipping group

  Returns:

  property Subtotal

  setTaxableSubtotal

  public void setTaxableSubtotal(ShippingPriceSubtotal pTaxableSubtotal)

  the taxable subtotal of all items in this shipping group

  Parameters:

  pTaxableSubtotal - new value to set

  getTaxableSubtotal

  public ShippingPriceSubtotal getTaxableSubtotal()

  the taxable subtotal of all items in this shipping group

  Returns:

  property TaxableSubtotal

  setNonTaxableSubtotal

  public void setNonTaxableSubtotal(ShippingPriceSubtotal pNonTaxableSubtotal)

  the nontaxable subtotal of all items in this shipping group

  Parameters:

  pNonTaxableSubtotal - new value to set

  getNonTaxableSubtotal

  public ShippingPriceSubtotal getNonTaxableSubtotal()

  the nontaxable subtotal of all items in this shipping group

  Returns:

  property NonTaxableSubtotal

  setTax

  public void setTax(TaxPrice pTax)

  the total tax of all items in this shipping group

  Parameters:

  pTax - new value to set

  getTax

  public TaxPrice getTax()

  the total tax of all items in this shipping group

  Returns:

  property Tax

  setAdjustments

  public void setAdjustments(PriceAdjustment[] pAdjustments)

  the discounts of all items in this shipping group

  Parameters:

  pAdjustments - new value to set

  getAdjustments

  public PriceAdjustment[] getAdjustments()

  the discounts of all items in this shipping group

  Returns:

  property Adjustments

  toString

  public java.lang.String toString()

  Returns a string form of this price information

  Overrides:

  toString in class java.lang.Object