Cart

java.lang.Object
- com.dpslink.base.obj.MappedAttributesObject
- - com.dpslink.base.jdbc.JDBCObject<Cart>
  - - com.dpslink.flash.db.Cart

All Implemented Interfaces:

JDBCObjectKey<Cart>, java.io.Serializable, java.lang.Comparable<Cart>
```
public class Cart
extends JDBCObject<Cart>
```
Defines the fields and methods for cart table objects.
There are two types of carts: shopping and favorites.

Shopping Cart
- A shopping cart contains information about a single user interactive shopping session. General information such as address and shipping method are kept as well as line item specific information such as product codes, prices and order quantities. The information contained in the shopping cart is used to create an order if the user places an order from the interactive shopping session.
- A cart has a unique identifier which is obtained from NextNumber when the cart is created. The id of the cart is stored on the user's PC in a cookie.
- A cart is automatically determined for each session when a servlet that extends FlashServlet is executed. The cart is persisted to the database as it is updated during the session so it can be recovered should the session be interrupted. The cart id stored in the cookie is used to recover the cart from the database.
Favorites Cart
- Need information here about favorites.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ORDERTYPE_ORDER` The order type for an order.
`static char`	`ORDERTYPE_QUOTE` The order type for a quote.
`static int`	`PAY_COD` The payment method type for COD.
`static int`	`PAY_CREDITCARD` The payment method type for credit card.
`static int`	`PAY_ONACCOUNT` The payment method type for on account.
`static int`	`PAY_UNKNOWN` The payment method type for unknown.
`private static long`	`serialVersionUID` The class' serialization version id.
`static java.lang.String`	`TYPE_FAVORITE` The cart type for a favorites cart.
`static java.lang.String`	`TYPE_SHOPPING` The cart type for a shopping cart.

Fields inherited from class com.dpslink.base.jdbc.JDBCObject
LOWVAL_RPG_DATE, LOWVAL_RPG_TIME, STATUS_ACTIVE, STATUS_BLANK, STATUS_CANCELED, STATUS_DELETED, STATUS_INACTIVE, STATUS_PENDING

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject
ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors
Constructor and Description

Cart()
Constructs a Cart object with all field values set to null.

Constructors
Constructor and Description
`Cart()` Constructs a `Cart` object with all field values set to `null`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdjustmentLine(CartAdjustmentLine line)` (not persisted) Adds an adjustment line to the collection of adjustment lines.
`boolean`	`addCartLine(FlashServletContext ctx, CartLine cartline)` Adds a new cart line to this cart's collection of cart lines and to the cart line database table.
`boolean`	`addCartLine(FlashServletContext ctx, Product product, int quantity)` Adds a new cart line to this cart's collection of cart lines and to the cart line database table.
`boolean`	`addCartLine(FlashServletContext ctx, Product product, int quantity, UnitMeasure orderuom, UnitMeasure priceuom)` Adds a new cart line to this cart's collection of cart lines and to the cart line database table.
`boolean`	`addCartLines(FlashServletContext ctx, java.util.ArrayList<Product> products, java.util.ArrayList<java.lang.Integer> quantities)` Adds one or more new cart lines to this cart's collection of cart lines and to the cart line database table.
`boolean`	`addCartLines(FlashServletContext ctx, java.util.ArrayList<Product> products, java.util.ArrayList<java.lang.Integer> quantities, java.util.ArrayList<UnitMeasure> orderuoms, java.util.ArrayList<UnitMeasure> priceuoms)` Adds one or more new cart lines to this cart's collection of cart lines and to the cart line database table.
`void`	`addConfirmationLine(CartConfirmationLine line)` (not persisted) Adds a confirmation line to the collection of confirmation lines.
`void`	`deleteAdjustmentLines()` (not persisted) Deletes all adjustment lines from the collection of adjustment lines.
`boolean`	`deleteCartLine(FlashServletContext ctx, CartLine cartline)` Deletes a cart line from the cartline database table.
`boolean`	`deleteCartLine(FlashServletContext ctx, int index)` Deletes a cart line from this cart's collection of cart lines and also deletes the cart line from the cart line database table.
`boolean`	`deleteCartLines(FlashServletContext ctx)` Deletes all cart lines from the collection of cart lines and from the cart line database table.
`boolean`	`deleteCartLines(FlashServletContext ctx, java.util.ArrayList<java.lang.Integer> indexes)` Deletes one or more cart lines from this cart's collection of cart lines and also deletes the cart lines from the cart line database table.
`void`	`deleteConfirmationLines()` (not persisted) Deletes all confirmation lines from the collection of confirmation lines.
`java.lang.String`	`getAddToOrder()` (not persisted) Returns the add to existing order attribute.
`java.util.ArrayList<CartAdjustmentLine>`	`getAdjustmentLines()` (not persisted) Returns the collection of adjustment lines.
`CartLine`	`getCartLine(FlashServletContext ctx, int index)` Returns the cart line at the given index.
`java.util.ArrayList<CartLine>`	`getCartLines(FlashServletContext ctx)` Returns the collection of cart lines for this cart.
`int`	`getCartLinesQuantity(FlashServletContext ctx)` Returns the total quantity of all cart lines for this cart.
`java.lang.String`	`getComments()` (not persisted) Returns the order comments.
`java.util.ArrayList<CartConfirmationLine>`	`getConfirmationLines()` (not persisted) Returns the collection of confirmation lines.
`java.lang.String`	`getConfirmContractNumber()` (not persisted) Returns the confirmed contract number.
`CreditCard`	`getConfirmCreditCard()` (not persisted) Returns the confirmed credit card object.
`java.util.Date`	`getConfirmOrderDate()` (not persisted) Returns the confirmed order date.
`int`	`getConfirmPayMethod()` (not persisted) Returns the confirmed payment method.
`java.lang.String`	`getConfirmPONumber()` (not persisted) Returns the confirmed customer P.O.
`Shipper`	`getConfirmShipper()` (not persisted) Returns the confirmed shipper object.
`Customer`	`getConfirmShipto()` (not persisted) Returns the confirmed ship-to customer object.
`java.lang.String`	`getConfirmUserDefinedField1()` (not persisted) Returns the confirmed order additional info.
`java.lang.String`	`getContractNumber()` (not persisted) Returns the contract number.
`CreditCard`	`getCreditCard()` (not persisted) Returns the credit card object.
`java.math.BigDecimal`	`getFreight()` (not persisted) Returns the freight charge amount.
`java.lang.String`	`getId()` Returns the unique id for the shopping cart or favorite items.
`java.util.Date`	`getLastAccess()` Returns the last time the shopping cart or favorite items was accessed.
`java.lang.String`	`getOrderId()` (not persisted) Returns the id of order in the ERP system.
`int`	`getOrderRef()` (not persisted) Returns the unique reference number for the order.
`char`	`getOrderType()` (not persisted) Returns the type of the order in the ERP system.
`int`	`getPayMethod()` (not persisted) Returns the payment method.
`java.lang.String`	`getPONumber()` (not persisted) Returns the customer P.O.
`java.lang.String`	`getReorderId()` (not persisted) Returns the order id that a reorder is based on.
`java.util.Date`	`getReqShipDate()` (not persisted) Returns the requested ship date.
`Shipper`	`getShipper()` (not persisted) Returns the shipper object.
`Customer`	`getShipto()` (not persisted) Returns the ship-to customer object.
`java.math.BigDecimal`	`getTax()` (not persisted) Returns the sales tax amount.
`java.lang.String`	`getType()` Returns the cart type code.
`java.lang.String`	`getUserDefinedField1()` (not persisted) Returns the order additional info.
`java.math.BigDecimal`	`getValue()` (not persisted) Returns the total order amount.
`boolean`	`hasCartLines()` Answers if cart line items have been retrieved and cached for this cart (i.e.
`int`	`isProductInCart(FlashServletContext ctx, Product product)` Answers if a given product is already in the cart.
`void`	`refreshCartLines(FlashServletContext ctx)` Refreshes the cart's cart lines.
`void`	`resetCartLines()` Resets the cart line cache to `null` so the next request for the cart's cart lines is forced to retrieve a fresh copy from the database.
`void`	`setAddToOrder(java.lang.String value)` (not persisted) Sets the add to existing order attribute.
`void`	`setComments(java.lang.String value)` (not persisted) Sets the order comments.
`void`	`setConfirmContractNumber(java.lang.String value)` (not persisted) Sets the confirmed contract number.
`void`	`setConfirmCreditCard(CreditCard value)` (not persisted) Sets the confirmed credit card object.
`void`	`setConfirmOrderDate(java.util.Date value)` (not persisted) Sets the confirmed order date.
`void`	`setConfirmPayMethod(int value)` (not persisted) Sets the confirmed payment method.
`void`	`setConfirmPONumber(java.lang.String value)` (not persisted) Sets the confirmed customer P.O.
`void`	`setConfirmShipper(Shipper value)` (not persisted) Sets the confirmed shipper object.
`void`	`setConfirmShipto(Customer value)` (not persisted) Sets the confirmed ship-to customer object.
`void`	`setConfirmUserDefinedField1(java.lang.String value)` (not persisted) Sets the confirmed order additional info.
`void`	`setContractNumber(java.lang.String value)` (not persisted) Sets the contract number.
`void`	`setCreditCard(CreditCard value)` (not persisted) Sets the credit card object.
`void`	`setFreight(java.math.BigDecimal value)` (not persisted) Sets the freight charge amount.
`void`	`setId(java.lang.String value)` Sets the unique id for the shopping cart or favorite items.
`void`	`setLastAccess(java.util.Date value)` Sets the last time the shopping cart or favorite items was accessed.
`void`	`setOrderId(java.lang.String value)` (not persisted) Sets the id of order in the ERP system.
`void`	`setOrderRef(int value)` (not persisted) Sets the unique reference number for the order.
`void`	`setOrderType(char value)` (not persisted) Sets the type of the order in the ERP system.
`void`	`setPayMethod(int value)` (not persisted) Sets the payment method.
`void`	`setPONumber(java.lang.String value)` (not persisted) Sets the customer P.O.
`void`	`setRealtimeInfo(FlashServletContext ctx)` Sets the realtime information (current price, availability, etc.) for each product within this cart's set of cart lines.
`private void`	`setRealtimeInfo(FlashServletContext ctx, java.util.ArrayList<CartLine> cartlines)` Sets the realtime information (current price, availability, etc.) for each product within a given set of cart lines.
`void`	`setReorderId(java.lang.String value)` (not persisted) Sets the order id that a reorder is based on.
`void`	`setReqShipDate(java.util.Date value)` (not persisted) Sets the requested ship date.
`void`	`setShipper(Shipper value)` (not persisted) Sets the shipper object.
`void`	`setShipto(Customer value)` (not persisted) Sets the ship-to customer object.
`void`	`setTax(java.math.BigDecimal value)` (not persisted) Sets the sales tax amount.
`void`	`setType(java.lang.String value)` Sets the cart type code.
`void`	`setUserDefinedField1(java.lang.String value)` (not persisted) Sets the order additional info.
`void`	`setValue(java.math.BigDecimal value)` (not persisted) Sets the total order amount.
`boolean`	`updateCartLine(FlashServletContext ctx, CartLine cartline)` Updates a cart line in the collection of cart lines and in the cart line database table.
`boolean`	`updateCartLine(FlashServletContext ctx, int index, int quantity, UnitMeasure orderuom, UnitMeasure priceuom)` Updates the values for a cart line in the collection of cart lines and in the cart line database table.
`boolean`	`updateCartLines(FlashServletContext ctx, java.util.ArrayList<java.lang.Integer> quantities, java.util.ArrayList<UnitMeasure> orderuoms, java.util.ArrayList<UnitMeasure> priceuoms)` Updates the values for one or more cart lines in the collection of cart lines and in the cart line database table.
`boolean`	`updateLastAccess(FlashServletContext ctx)` Updates the last time the shopping cart or favorite items was accessed to the current date and time.

Methods inherited from class com.dpslink.base.jdbc.JDBCObject
after, before, compareTo, equals, fmtStatus, fmtStatus, getObjectStatus, hashKey, setObjectStatus

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject
cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - TYPE_SHOPPING
```
public static final java.lang.String TYPE_SHOPPING
```
    The cart type for a shopping cart.
    
    See Also:
    
    Constant Field Values
  - TYPE_FAVORITE
```
public static final java.lang.String TYPE_FAVORITE
```
    The cart type for a favorites cart.
    
    See Also:
    
    Constant Field Values
  - PAY_UNKNOWN
```
public static final int PAY_UNKNOWN
```
    The payment method type for unknown.
    
    See Also:
    
    Constant Field Values
  - PAY_CREDITCARD
```
public static final int PAY_CREDITCARD
```
    The payment method type for credit card.
    
    See Also:
    
    Constant Field Values
  - PAY_ONACCOUNT
```
public static final int PAY_ONACCOUNT
```
    The payment method type for on account.
    
    See Also:
    
    Constant Field Values
  - PAY_COD
```
public static final int PAY_COD
```
    The payment method type for COD.
    
    See Also:
    
    Constant Field Values
  - ORDERTYPE_ORDER
```
public static final char ORDERTYPE_ORDER
```
    The order type for an order.
    
    See Also:
    
    Constant Field Values
  - ORDERTYPE_QUOTE
```
public static final char ORDERTYPE_QUOTE
```
    The order type for a quote.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cart
```
public Cart()
```
    Constructs a Cart object with all field values set to null.
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Returns the unique id for the shopping cart or favorite items.
    
    Returns:
    
    String - The unique id for the shopping cart or favorite items.
  - setId
```
public void setId(java.lang.String value)
```
    Sets the unique id for the shopping cart or favorite items.
    
    Parameters:
    
    value - (String) The unique id for the shopping cart or favorite items.
  - getLastAccess
```
public java.util.Date getLastAccess()
```
    Returns the last time the shopping cart or favorite items was accessed.
    
    Returns:
    
    java.util.Date - The last time the shopping cart or favorite items was accessed.
  - setLastAccess
```
public void setLastAccess(java.util.Date value)
```
    Sets the last time the shopping cart or favorite items was accessed.
    
    Parameters:
    
    value - (java.util.Date) The last time the shopping cart or favorite items was accessed.
  - getType
```
public java.lang.String getType()
```
    Returns the cart type code.
    
    Returns:
    
    String - The cart type code.
  - setType
```
public void setType(java.lang.String value)
```
    Sets the cart type code.
    
    Parameters:
    
    value - (String) The cart type code.
  - getShipto
```
public Customer getShipto()
```
    (not persisted) Returns the ship-to customer object.
    
    Returns:
    
    Customer - The ship-to customer.
  - setShipto
```
public void setShipto(Customer value)
```
    (not persisted) Sets the ship-to customer object.
    
    Parameters:
    
    value - (Customer) The ship-to customer.
  - getPONumber
```
public java.lang.String getPONumber()
```
    (not persisted) Returns the customer P.O. number.
    
    Returns:
    
    String - The P.O. number.
  - setPONumber
```
public void setPONumber(java.lang.String value)
```
    (not persisted) Sets the customer P.O. number.
    
    Parameters:
    
    value - (String) The P.O. number.
  - getContractNumber
```
public java.lang.String getContractNumber()
```
    (not persisted) Returns the contract number.
    
    Returns:
    
    String - The contract number.
  - setContractNumber
```
public void setContractNumber(java.lang.String value)
```
    (not persisted) Sets the contract number.
    
    Parameters:
    
    value - (String) The contract number.
  - getComments
```
public java.lang.String getComments()
```
    (not persisted) Returns the order comments.
    
    Returns:
    
    String - The order comments.
  - setComments
```
public void setComments(java.lang.String value)
```
    (not persisted) Sets the order comments.
    
    Parameters:
    
    value - (String) The order comments.
  - getShipper
```
public Shipper getShipper()
```
    (not persisted) Returns the shipper object.
    
    Returns:
    
    Shipper - The shipper for the cart.
  - setShipper
```
public void setShipper(Shipper value)
```
    (not persisted) Sets the shipper object.
    
    Parameters:
    
    value - (Shipper) The shipper for this cart.
  - getReqShipDate
```
public java.util.Date getReqShipDate()
```
    (not persisted) Returns the requested ship date.
    
    Returns:
    
    Date - The requested ship date.
  - setReqShipDate
```
public void setReqShipDate(java.util.Date value)
```
    (not persisted) Sets the requested ship date.
    
    Parameters:
    
    value - (Date) The requested ship date.
  - getPayMethod
```
public int getPayMethod()
```
    (not persisted) Returns the payment method.
    
    Returns:
    
    int - The payment method.
  - setPayMethod
```
public void setPayMethod(int value)
```
    (not persisted) Sets the payment method.
    
    Parameters:
    
    value - (int) The payment method.
  - getCreditCard
```
public CreditCard getCreditCard()
```
    (not persisted) Returns the credit card object.
    
    Returns:
    
    CreditCard - The credit card.
  - setCreditCard
```
public void setCreditCard(CreditCard value)
```
    (not persisted) Sets the credit card object.
    
    Parameters:
    
    value - (CreditCard) The credit card.
  - getUserDefinedField1
```
public java.lang.String getUserDefinedField1()
```
    (not persisted) Returns the order additional info.
    
    Returns:
    
    String - The additional info.
  - setUserDefinedField1
```
public void setUserDefinedField1(java.lang.String value)
```
    (not persisted) Sets the order additional info.
    
    Parameters:
    
    value - (String) The additional info.
  - getConfirmOrderDate
```
public java.util.Date getConfirmOrderDate()
```
    (not persisted) Returns the confirmed order date.
    
    Returns:
    
    Date - The confirmed order date.
  - setConfirmOrderDate
```
public void setConfirmOrderDate(java.util.Date value)
```
    (not persisted) Sets the confirmed order date.
    
    Parameters:
    
    value - (Date) The confirmed order date.
  - getConfirmShipto
```
public Customer getConfirmShipto()
```
    (not persisted) Returns the confirmed ship-to customer object.
    
    Returns:
    
    Customer - The confirmed ship-to customer.
  - setConfirmShipto
```
public void setConfirmShipto(Customer value)
```
    (not persisted) Sets the confirmed ship-to customer object.
    
    Parameters:
    
    value - (Customer) The confirmed ship-to customer.
  - getConfirmPONumber
```
public java.lang.String getConfirmPONumber()
```
    (not persisted) Returns the confirmed customer P.O. number.
    
    Returns:
    
    String - The confirmed P.O. number.
  - setConfirmPONumber
```
public void setConfirmPONumber(java.lang.String value)
```
    (not persisted) Sets the confirmed customer P.O. number.
    
    Parameters:
    
    value - (String) The confirmed P.O. number.
  - getConfirmContractNumber
```
public java.lang.String getConfirmContractNumber()
```
    (not persisted) Returns the confirmed contract number.
    
    Returns:
    
    String - The confirmed contract number.
  - setConfirmContractNumber
```
public void setConfirmContractNumber(java.lang.String value)
```
    (not persisted) Sets the confirmed contract number.
    
    Parameters:
    
    value - (String) The confirmed contract number.
  - getConfirmShipper
```
public Shipper getConfirmShipper()
```
    (not persisted) Returns the confirmed shipper object.
    
    Returns:
    
    Shipper - The confirmed shipper for the cart.
  - setConfirmShipper
```
public void setConfirmShipper(Shipper value)
```
    (not persisted) Sets the confirmed shipper object.
    
    Parameters:
    
    value - (Shipper) The confirmed shipper for this cart.
  - getConfirmPayMethod
```
public int getConfirmPayMethod()
```
    (not persisted) Returns the confirmed payment method.
    
    Returns:
    
    int - The confirmed payment method.
  - setConfirmPayMethod
```
public void setConfirmPayMethod(int value)
```
    (not persisted) Sets the confirmed payment method.
    
    Parameters:
    
    value - (int) The confirmed payment method.
  - getConfirmCreditCard
```
public CreditCard getConfirmCreditCard()
```
    (not persisted) Returns the confirmed credit card object.
    
    Returns:
    
    CreditCard - The confirmed credit card.
  - setConfirmCreditCard
```
public void setConfirmCreditCard(CreditCard value)
```
    (not persisted) Sets the confirmed credit card object.
    
    Parameters:
    
    value - (CreditCard) The confirmed credit card.
  - getConfirmUserDefinedField1
```
public java.lang.String getConfirmUserDefinedField1()
```
    (not persisted) Returns the confirmed order additional info.
    
    Returns:
    
    String - The confirmed additional info.
  - setConfirmUserDefinedField1
```
public void setConfirmUserDefinedField1(java.lang.String value)
```
    (not persisted) Sets the confirmed order additional info.
    
    Parameters:
    
    value - (String) The confirmed additional info.
  - getFreight
```
public java.math.BigDecimal getFreight()
```
    (not persisted) Returns the freight charge amount.
    
    Returns:
    
    BigDecimal - The freight charge amount.
  - setFreight
```
public void setFreight(java.math.BigDecimal value)
```
    (not persisted) Sets the freight charge amount.
    
    Parameters:
    
    value - (BigDecimal) The freight charge amount.
  - getTax
```
public java.math.BigDecimal getTax()
```
    (not persisted) Returns the sales tax amount.
    
    Returns:
    
    BigDecimal - The sales tax amount.
  - setTax
```
public void setTax(java.math.BigDecimal value)
```
    (not persisted) Sets the sales tax amount.
    
    Parameters:
    
    value - (BigDecimal) The sales tax amount.
  - getValue
```
public java.math.BigDecimal getValue()
```
    (not persisted) Returns the total order amount.
    
    Returns:
    
    BigDecimal - The total order amount.
  - setValue
```
public void setValue(java.math.BigDecimal value)
```
    (not persisted) Sets the total order amount.
    
    Parameters:
    
    value - (BigDecimal) The total order amount.
  - getOrderId
```
public java.lang.String getOrderId()
```
    (not persisted) Returns the id of order in the ERP system.
    
    Returns:
    
    String - The id of order in the ERP system.
  - setOrderId
```
public void setOrderId(java.lang.String value)
```
    (not persisted) Sets the id of order in the ERP system.
    
    Parameters:
    
    value - (String) The id of order in the ERP system.
  - getOrderType
```
public char getOrderType()
```
    (not persisted) Returns the type of the order in the ERP system.
    
    Returns:
    
    char - The type of the order in the ERP system.
  - setOrderType
```
public void setOrderType(char value)
```
    (not persisted) Sets the type of the order in the ERP system.
    
    Parameters:
    
    value - (char) The type of the order in the ERP system.
  - getReorderId
```
public java.lang.String getReorderId()
```
    (not persisted) Returns the order id that a reorder is based on.
    
    Returns:
    
    String - The order id that a reorder is based on.
  - setReorderId
```
public void setReorderId(java.lang.String value)
```
    (not persisted) Sets the order id that a reorder is based on.
    
    Parameters:
    
    value - (String) The order id that a reorder is based on.
  - getOrderRef
```
public int getOrderRef()
```
    (not persisted) Returns the unique reference number for the order.
    
    Returns:
    
    int - The unique reference number for the order.
  - setOrderRef
```
public void setOrderRef(int value)
```
    (not persisted) Sets the unique reference number for the order.
    
    Parameters:
    
    value - (int) The unique reference number for the order.
  - getAddToOrder
```
public java.lang.String getAddToOrder()
```
    (not persisted) Returns the add to existing order attribute.
    
    Returns:
    
    String - the order number being added to.
  - setAddToOrder
```
public void setAddToOrder(java.lang.String value)
```
    (not persisted) Sets the add to existing order attribute.
    
    Parameters:
    
    value - (String) The order number value.
  - addAdjustmentLine
```
public void addAdjustmentLine(CartAdjustmentLine line)
```
    (not persisted) Adds an adjustment line to the collection of adjustment lines.
    
    Parameters:
    
    line - (CartAdjustmentLine) The adjustment line.
  - deleteAdjustmentLines
```
public void deleteAdjustmentLines()
```
    (not persisted) Deletes all adjustment lines from the collection of adjustment lines.
  - getAdjustmentLines
```
public java.util.ArrayList<CartAdjustmentLine> getAdjustmentLines()
```
    (not persisted) Returns the collection of adjustment lines.
    
    Returns:
    
    ArrayList - The collection of adjustment lines.
  - addConfirmationLine
```
public void addConfirmationLine(CartConfirmationLine line)
```
    (not persisted) Adds a confirmation line to the collection of confirmation lines.
    
    Parameters:
    
    line - (CartConfirmationLine) The confirmation line.
  - deleteConfirmationLines
```
public void deleteConfirmationLines()
```
    (not persisted) Deletes all confirmation lines from the collection of confirmation lines.
  - getConfirmationLines
```
public java.util.ArrayList<CartConfirmationLine> getConfirmationLines()
```
    (not persisted) Returns the collection of confirmation lines.
    
    Returns:
    
    ArrayList - The collection of confirmation lines.
  - addCartLine
```
public boolean addCartLine(FlashServletContext ctx,
                           CartLine cartline)
```
    Adds a new cart line to this cart's collection of cart lines and to the cart line database table. The add is based on the configured add-to-cart strategy.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    cartline - (CartLine) The cart line to add.
    
    Returns:
    
    boolean - true if the cart line successfully added, otherwise false.
  - addCartLine
```
public boolean addCartLine(FlashServletContext ctx,
                           Product product,
                           int quantity)
```
    Adds a new cart line to this cart's collection of cart lines and to the cart line database table. The add is based on the configured add-to-cart strategy.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    product - (Product) The product to add.
    
    quantity - (int) The product's order quantity.
    
    Returns:
    
    boolean - true if the product successfully added, otherwise false.
  - addCartLine
```
public boolean addCartLine(FlashServletContext ctx,
                           Product product,
                           int quantity,
                           UnitMeasure orderuom,
                           UnitMeasure priceuom)
```
    Adds a new cart line to this cart's collection of cart lines and to the cart line database table. The add is based on the configured add-to-cart strategy.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    product - (Product) The product to add.
    
    quantity - (int) The product's order quantity.
    
    orderuom - (UnitMeasure) The order unit of measure. Will be null if multiple uom processing is not active or if multiple uom processing is active and cart lines are added from anywhere other than the product details page.
    
    priceuom - (UnitMeasure) The price unit of measure. Will be null if multiple uom processing is not active or if multiple uom processing is active and cart lines are added from anywhere other than the product details page.
    
    Returns:
    
    boolean - true if the cart line successfully added, otherwise false.
  - addCartLines
```
public boolean addCartLines(FlashServletContext ctx,
                            java.util.ArrayList<Product> products,
                            java.util.ArrayList<java.lang.Integer> quantities)
```
    Adds one or more new cart lines to this cart's collection of cart lines and to the cart line database table. The adds are based on the configured add-to-cart strategy.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    products - (ArrayList) The products to add.
    
    quantities - (ArrayList) The quantities associated with the products being added.
    
    Returns:
    
    boolean - true if the cart lines successfully added, otherwise false.
  - addCartLines
```
public boolean addCartLines(FlashServletContext ctx,
                            java.util.ArrayList<Product> products,
                            java.util.ArrayList<java.lang.Integer> quantities,
                            java.util.ArrayList<UnitMeasure> orderuoms,
                            java.util.ArrayList<UnitMeasure> priceuoms)
```
    Adds one or more new cart lines to this cart's collection of cart lines and to the cart line database table. The adds are based on the configured add-to-cart strategy.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    products - (ArrayList) The products to add.
    
    quantities - (ArrayList) The quantities associated with the products being added.
    
    orderuoms - (ArrayList) The order units of measure associated with the products being added. Note that this parameter may be null.
    
    priceuoms - (ArrayList) The price units of measure associated with the products being added. Note that this parameter may be null.
    
    Returns:
    
    boolean - true if the cart lines successfully added, otherwise false.
  - deleteCartLine
```
public boolean deleteCartLine(FlashServletContext ctx,
                              CartLine cartline)
```
    Deletes a cart line from the cartline database table. This is a convenience shortcut to the delete method in CartLineController.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    cartline - (CartLine) The cart line to delete.
    
    Returns:
    
    boolean - true if the cart line successfully deleted, otherwise false.
  - deleteCartLine
```
public boolean deleteCartLine(FlashServletContext ctx,
                              int index)
```
    Deletes a cart line from this cart's collection of cart lines and also deletes the cart line from the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    index - (int) The index in the cart line collection for the line to delete.
    
    Returns:
    
    boolean - true if the cart line successfully deleted, otherwise false.
  - deleteCartLines
```
public boolean deleteCartLines(FlashServletContext ctx)
```
    Deletes all cart lines from the collection of cart lines and from the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    Returns:
    
    boolean - true if the cart lines successfully deleted, otherwise false.
  - deleteCartLines
```
public boolean deleteCartLines(FlashServletContext ctx,
                               java.util.ArrayList<java.lang.Integer> indexes)
```
    Deletes one or more cart lines from this cart's collection of cart lines and also deletes the cart lines from the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    indexes - (ArrayList) The indexes in the cart line collection for the lines to delete.
    
    Returns:
    
    boolean - true if the cart lines successfully deleted, otherwise false.
  - getCartLine
```
public CartLine getCartLine(FlashServletContext ctx,
                            int index)
```
    Returns the cart line at the given index. The supplied index must be per the desired cart line's relative position within the collection of cart lines vs. the cart line's physical line number. If the cart lines have previously been retrieved from the database and cached, a cart line from the cached collection is returned; otherwise the cart lines are retrieved and placed in the cache and then a cart line is returned.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    Returns:
    
    CartLine - The requested cart line or null if the cart has no cart lines or if the supplied index is out of range.
  - getCartLines
```
public java.util.ArrayList<CartLine> getCartLines(FlashServletContext ctx)
```
    Returns the collection of cart lines for this cart. If the cart lines have previously been retrieved from the database and cached, the cached collection is returned; otherwise the cart lines are retrieved and placed in the cache and then returned.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context. Pass a null to only retrieve from the cache.
    
    Returns:
    
    ArrayList - The collection of cart lines for this cart.
  - getCartLinesQuantity
```
public int getCartLinesQuantity(FlashServletContext ctx)
```
    Returns the total quantity of all cart lines for this cart.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context. Pass a null to only retrieve from the cache.
    
    Returns:
    
    int - The total quantity of all cart lines.
  - hasCartLines
```
public boolean hasCartLines()
```
    Answers if cart line items have been retrieved and cached for this cart (i.e. the cache is either null or not null). The answer returned here simply indicates whether cart lines have been retrieved and cached; it is not an indicator of whether the cart actually has any cart lines in the database. To determine the latter, invoke getCartLines and check for an empty collection.
    
    Returns:
    
    boolean - true if cart lines have been retrieved and cached, otherwise false.
  - refreshCartLines
```
public void refreshCartLines(FlashServletContext ctx)
```
    Refreshes the cart's cart lines. Verifies user catalog, retrieves realtime info, resets uom info, resets price override, etc. Typically invoked when something occurs which impacts a cart's values, such as when a retail site user logs on after they have already done some shopping as the default user.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
  - resetCartLines
```
public void resetCartLines()
```
    Resets the cart line cache to null so the next request for the cart's cart lines is forced to retrieve a fresh copy from the database.
  - updateCartLine
```
public boolean updateCartLine(FlashServletContext ctx,
                              CartLine cartline)
```
    Updates a cart line in the collection of cart lines and in the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    cartline - (CartLine) The cart line to update.
    
    Returns:
    
    boolean - true if the cart line successfully updated, otherwise false.
  - updateCartLine
```
public boolean updateCartLine(FlashServletContext ctx,
                              int index,
                              int quantity,
                              UnitMeasure orderuom,
                              UnitMeasure priceuom)
```
    Updates the values for a cart line in the collection of cart lines and in the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    index - (int) The index in the cart line collection for the line to update.
    
    quantity - (int) The new order quantity.
    
    orderuom - (UnitMeasure) The order unit of measure. Will be null if multiple uom processing is not active.
    
    priceuom - (UnitMeasure) The price unit of measure. Will be null if multiple uom processing is not active.
    
    Returns:
    
    boolean - true if the cart line successfully updated, otherwise false.
  - updateCartLines
```
public boolean updateCartLines(FlashServletContext ctx,
                               java.util.ArrayList<java.lang.Integer> quantities,
                               java.util.ArrayList<UnitMeasure> orderuoms,
                               java.util.ArrayList<UnitMeasure> priceuoms)
```
    Updates the values for one or more cart lines in the collection of cart lines and in the cart line database table.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    quantities - (ArrayList) The quantities that are to be updated in the cart. The sequence of the collection elements must coincide with the sequence of the cart lines in the cart.
    
    orderuoms - (ArrayList) The order units of measure that are to be updated in the cart. The sequence of the collection elements must coincide with the sequence of the cart lines in the cart. Note that this parameter may be null.
    
    priceuoms - (ArrayList) The price units of measure that are to be updated in the cart. The sequence of the collection elements must coincide with the sequence of the cart lines in the cart. Note that this parameter may be null.
    
    Returns:
    
    boolean - true if the cart lines successfully updated, otherwise false.
  - updateLastAccess
```
public boolean updateLastAccess(FlashServletContext ctx)
```
    Updates the last time the shopping cart or favorite items was accessed to the current date and time.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    Returns:
    
    boolean - true if the cart was successfully updated, otherwise false.
  - isProductInCart
```
public int isProductInCart(FlashServletContext ctx,
                           Product product)
```
    Answers if a given product is already in the cart. If the product is found and cart line's requested ship date and contract number are blank, method returns the cart line index for where the product was found. Returns negative one (-1) if the product is not found.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    product - (Product) A product to search for in the cart.
    
    Returns:
    
    int - The cart line index for where the product was found, or negative one (-1) if the product was not found.
  - setRealtimeInfo
```
public void setRealtimeInfo(FlashServletContext ctx)
```
    Sets the realtime information (current price, availability, etc.) for each product within this cart's set of cart lines.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
  - setRealtimeInfo
```
private void setRealtimeInfo(FlashServletContext ctx,
                             java.util.ArrayList<CartLine> cartlines)
```
    Sets the realtime information (current price, availability, etc.) for each product within a given set of cart lines.
    
    Parameters:
    
    ctx - (FlashServletContext) The current servlet context.
    
    cartlines - (ArrayList) The cart lines to process.

Class Cart

Field Summary

Fields inherited from class com.dpslink.base.jdbc.JDBCObject

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

Constructor Summary

Method Summary

Methods inherited from class com.dpslink.base.jdbc.JDBCObject

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

TYPE_SHOPPING

TYPE_FAVORITE

PAY_UNKNOWN

PAY_CREDITCARD

PAY_ONACCOUNT

PAY_COD

ORDERTYPE_ORDER

ORDERTYPE_QUOTE

Constructor Detail

Cart

Method Detail

getId

setId

getLastAccess

setLastAccess

getType

setType

getShipto

setShipto

getPONumber

setPONumber

getContractNumber

setContractNumber

getComments

setComments

getShipper

setShipper

getReqShipDate

setReqShipDate

getPayMethod

setPayMethod

getCreditCard

setCreditCard

getUserDefinedField1

setUserDefinedField1

getConfirmOrderDate

setConfirmOrderDate

getConfirmShipto

setConfirmShipto

getConfirmPONumber

setConfirmPONumber

getConfirmContractNumber

setConfirmContractNumber

getConfirmShipper

setConfirmShipper

getConfirmPayMethod

setConfirmPayMethod

getConfirmCreditCard

setConfirmCreditCard

getConfirmUserDefinedField1

setConfirmUserDefinedField1

getFreight

setFreight

getTax

setTax

getValue

setValue

getOrderId

setOrderId

getOrderType

setOrderType

getReorderId

setReorderId

getOrderRef

setOrderRef

getAddToOrder

setAddToOrder

addAdjustmentLine

deleteAdjustmentLines