ShoppingCartItem (ofbiz API)

java.lang.Object
- org.apache.ofbiz.order.shoppingcart.ShoppingCartItem

All Implemented Interfaces:

Serializable
```
public class ShoppingCartItem
extends Object
implements Serializable
```
Title: ShoppingCartItem.java
Description: Shopping cart item object.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String[]`	`attributeNames`
`static MathContext`	`generalRounding`
`static String`	`module`
`static String`	`resource`
`static String`	`resource_error`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ShoppingCartItem()` Cannot create shopping cart item with no parameters
`protected`	`ShoppingCartItem(Delegator delegator, String itemTypeId, String description, String categoryId, BigDecimal basePrice, Map<String,Object> attributes, String prodCatalogId, Locale locale, ShoppingCart.ShoppingCartItemGroup itemGroup)` Creates new ShopingCartItem object.
`protected`	`ShoppingCartItem(GenericValue product, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, Locale locale, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup)` Deprecated. Use `#ShoppingCartItem(GenericValue, Map, Map, String, Locale, String, ShoppingCartItemGroup, LocalDispatcher)` instead
`protected`	`ShoppingCartItem(GenericValue product, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, Locale locale, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher)` Creates new ShoppingCartItem object.
`protected`	`ShoppingCartItem(GenericValue product, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, Locale locale, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, GenericValue parentProduct)` Creates new ShoppingCartItem object.
	`ShoppingCartItem(ShoppingCartItem item)` Clone an item.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addAdjustment(GenericValue adjustment)` Add an adjustment to the order item; don't worry about setting the orderId, orderItemSeqId or orderAdjustmentId; they will be set when the order is created
`void`	`addAllProductFeatureAndAppls(Map<String,GenericValue> productFeatureAndApplsToAdd)`
`void`	`addContactMech(String contactMechPurposeTypeId, String contactMechId)` Add a contact mech to this purpose; the contactMechPurposeTypeId is required
`BigDecimal`	`addPromoQuantityCandidateUse(BigDecimal quantityDesired, GenericValue productPromoCondAction, boolean checkAvailableOnly)`
`void`	`calcDepositAdjustments()`
`static String`	`checkAvailability(String productId, BigDecimal quantity, Timestamp reservStart, BigDecimal reservLength, ShoppingCart cart)` returns "OK" when the product can be booked or returns a string with the dates the related fixed Asset is not available
`void`	`clearPromoRuleUseInfo()`
`void`	`confirmPromoRuleUse(String productPromoId, String productPromoRuleId)`
`boolean`	`equals(Object obj)`
`boolean`	`equals(ShoppingCartItem item)`
`boolean`	`equals(String productId, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, BigDecimal selectedAmount)` Compares the specified object with this cart item.
`boolean`	`equals(String productId, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, BigDecimal selectedAmount, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, boolean isPromo)` Compares the specified object with this cart item.
`boolean`	`equals(String productId, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, BigDecimal selectedAmount)` Compares the specified object with this cart item.
`boolean`	`equals(String productId, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, BigDecimal selectedAmount)` Compares the specified object with this cart item including rental data.
`boolean`	`equals(String productId, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, String accommodationMapId, String accommodationSpotId, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, Map<String,String> orderItemAttributes, String prodCatalogId, BigDecimal selectedAmount, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, boolean isPromo)` Compares the specified object order item attributes.
`boolean`	`equals(String productId, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, String accommodationMapId, String accommodationSpotId, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, BigDecimal selectedAmount, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, boolean isPromo)` Compares the specified object with this cart item.
`List<ShoppingCartItem>`	`explodeItem(ShoppingCart cart, LocalDispatcher dispatcher)`
`static GenericValue`	`findProduct(Delegator delegator, boolean skipProductChecks, String prodCatalogId, String productId, Locale locale)`
`String`	`getAccommodationMapId()` Returns accommodationMapId
`String`	`getAccommodationSpotId()` Returns accommodationSpotId
`GenericValue`	`getAdditionalProductFeatureAndAppl(String productFeatureTypeId)`
`Map<String,GenericValue>`	`getAdditionalProductFeatureAndAppls()`
`List<GenericValue>`	`getAdjustments()`
`List<String>`	`getAlternativeOptionProductIds()`
`String`	`getAssociatedOrderId()` Returns the associatedId.
`String`	`getAssociatedOrderItemSeqId()` Returns the associatedOrderItemSeqId.
`Object`	`getAttribute(String name)` Return a specific attribute.
`Map<String,Object>`	`getAttributes()` Returns the attributes for the item.
`BigDecimal`	`getBasePrice()` Returns the base price.
`Timestamp`	`getCancelBackOrderDate()` Returns the cancel back order date
`ProductConfigWrapper`	`getConfigWrapper()`
`String`	`getContactMech(String contactMechPurposeTypeId)` Get the contactMechId for this item given the contactMechPurposeTypeId
`Delegator`	`getDelegator()`
`String`	`getDescription(LocalDispatcher dispatcher)` Returns the item's description.
`Timestamp`	`getDesiredDeliveryDate()` Returns the item's customer desired delivery date.
`BigDecimal`	`getDisplayItemRecurringSubTotal()`
`BigDecimal`	`getDisplayItemRecurringSubTotalNoAdj()`
`BigDecimal`	`getDisplayItemSubTotal()`
`BigDecimal`	`getDisplayItemSubTotalNoAdj()`
`BigDecimal`	`getDisplayPrice()`
`Timestamp`	`getEstimatedShipDate()` Returns the date to EstimatedShipDate
`String`	`getExternalId()`
`Map<String,BigDecimal>`	`getFeatureIdQtyMap(BigDecimal quantity)`
`Set<String>`	`getFeatureSet()` Returns a Set of the item's features
`List<GenericValue>`	`getFeaturesForSupplier(LocalDispatcher dispatcher, String partyId)` Returns a List of the item's features for supplier
`boolean`	`getIsModifiedPrice()` Returns isModifiedPrice
`boolean`	`getIsPromo()`
`String`	`getItemComment()` Returns the item's comment.
`ShoppingCart.ShoppingCartItemGroup`	`getItemGroup()` Returns the item group.
`Map<String,Object>`	`getItemProductInfo()`
`BigDecimal`	`getItemSubTotal()`
`BigDecimal`	`getItemSubTotal(BigDecimal quantity)` Returns the total line price.
`String`	`getItemType()` Returns the item type.
`String`	`getItemTypeDescription()` Returns the item type description.
`GenericValue`	`getItemTypeGenericValue()` Returns the item type.
`BigDecimal`	`getListPrice()` Returns the list price.
`String`	`getName()` Deprecated. use getName(LocalDispatcher dispatcher)
`String`	`getName(LocalDispatcher dispatcher)` Returns the item's description or PRODUCT_NAME from content.
`Map<String,List<GenericValue>>`	`getOptionalProductFeatures()`
`String`	`getOrderItemAssocTypeId()` Returns the OrderItemAssocTypeId.
`String`	`getOrderItemAttribute(String name)` Return an OrderItemAttribute.
`Map<String,String>`	`getOrderItemAttributes()`
`Map<String,String>`	`getOrderItemContactMechIds()`
`List<GenericValue>`	`getOrderItemPriceInfos()`
`String`	`getOrderItemSeqId()`
`BigDecimal`	`getOtherAdjustments()` Returns the "other" adjustments.
`BigDecimal`	`getOtherAdjustmentsRecurring()` Returns the "other" adjustments.
`GenericValue`	`getParentProduct()`
`String`	`getParentProductId()`
`long`	`getPiecesIncluded()` Returns the item's pieces included
`String`	`getProdCatalogId()`
`GenericValue`	`getProduct()` Gets the Product entity.
`String`	`getProductCategoryId()` Returns the productCategoryId for the item or null if none.
`String`	`getProductId()` Returns the item's productId.
`BigDecimal`	`getPromoQuantityAvailable()`
`BigDecimal`	`getPromoQuantityCandidateUse(GenericValue productPromoCondAction)`
`BigDecimal`	`getPromoQuantityCandidateUseActionAndAllConds(GenericValue productPromoAction)`
`BigDecimal`	`getPromoQuantityUsed()`
`static String`	`getPurchaseOrderItemDescription(GenericValue product, GenericValue supplierProduct, Locale locale, LocalDispatcher dispatcher)`
`BigDecimal`	`getQuantity()` Returns the quantity.
`Iterator<Map.Entry<GenericPK,BigDecimal>>`	`getQuantityUsedPerPromoActualIter()`
`Iterator<Map.Entry<GenericPK,BigDecimal>>`	`getQuantityUsedPerPromoCandidateIter()`
`Iterator<Map.Entry<GenericPK,BigDecimal>>`	`getQuantityUsedPerPromoFailedIter()`
`String`	`getQuoteId()` Returns the quoteId.
`String`	`getQuoteItemSeqId()` Returns the quoteItemSeqId.
`BigDecimal`	`getRecurringBasePrice()`
`BigDecimal`	`getRecurringDisplayPrice()`
`BigDecimal`	`getRentalAdjustment()` calculates for a reservation the percentage/100 extra for more than 1 person.
`String`	`getRequirementId()` Returns the requirementId.
`BigDecimal`	`getReserv2ndPPPerc()` get the percentage for the second person
`Timestamp`	`getReserveAfterDate()` Returns the date to ship after
`BigDecimal`	`getReservLength()` Returns the reservation length.
`BigDecimal`	`getReservNthPPPerc()` get the percentage for the third and following person
`BigDecimal`	`getReservPersons()` Returns the reservation number of persons.
`Timestamp`	`getReservStart()` Returns the reservation start date.
`Timestamp`	`getReservStart(BigDecimal addDays)` Returns the reservation start date with a number of days added.
`BigDecimal`	`getSelectedAmount()` Returns the user selected amount
`Timestamp`	`getShipAfterDate()` Returns the date to ship after
`Timestamp`	`getShipBeforeDate()` Returns the date to ship before
`String`	`getShoppingListId()`
`String`	`getShoppingListItemSeqId()`
`BigDecimal`	`getSize()` Returns the item's size (length + girth)
`BigDecimal`	`getSpecialPromoPrice()`
`List<GenericValue>`	`getStandardFeatureList()` Returns a list of the item's standard features
`String`	`getStatusId()`
`String`	`getSupplierProductId()` Returns the item's supplierProductId.
`BigDecimal`	`getWeight()` Returns the item's unit weight
`int`	`hashCode()`
`boolean`	`isInItemGroup(String groupNumber)`
`protected boolean`	`isInventoryAvailableOrNotRequired(BigDecimal quantity, String productStoreId, LocalDispatcher dispatcher)`
`static void`	`isValidCartProduct(ProductConfigWrapper configWrapper, GenericValue product, Timestamp nowTimestamp, Locale locale)`
`static ShoppingCartItem`	makeItem(Integer cartLocation, GenericValue product, BigDecimal selectedAmount, BigDecimal quantity, BigDecimal unitPrice, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, String accommodationMapId, String accommodationSpotId, Timestamp shipBeforeDate, Timestamp shipAfterDate, Timestamp reserveAfterDate, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool, Boolean triggerPriceRulesBool, GenericValue parentProduct, Boolean skipInventoryChecks, Boolean skipProductChecks) Makes a ShoppingCartItem and adds it to the cart.
`static ShoppingCartItem`	makeItem(Integer cartLocation, GenericValue product, BigDecimal selectedAmount, BigDecimal quantity, BigDecimal unitPrice, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, Timestamp shipBeforeDate, Timestamp shipAfterDate, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool, Boolean triggerPriceRulesBool, GenericValue parentProduct, Boolean skipInventoryChecks, Boolean skipProductChecks) Makes a ShoppingCartItem and adds it to the cart.
`static ShoppingCartItem`	makeItem(Integer cartLocation, String productId, BigDecimal selectedAmount, BigDecimal quantity, BigDecimal unitPrice, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, String accommodationMapId, String accommodationSpotId, Timestamp shipBeforeDate, Timestamp shipAfterDate, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool, Boolean triggerPriceRulesBool, String parentProductId, Boolean skipInventoryChecks, Boolean skipProductChecks)
`static ShoppingCartItem`	makeItem(Integer cartLocation, String productId, BigDecimal selectedAmount, BigDecimal quantity, BigDecimal unitPrice, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, String accommodationMapId, String accommodationSpotId, Timestamp shipBeforeDate, Timestamp shipAfterDate, Timestamp reserveAfterDate, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool, Boolean triggerPriceRulesBool, String parentProductId, Boolean skipInventoryChecks, Boolean skipProductChecks) Makes a ShoppingCartItem and adds it to the cart.
`static ShoppingCartItem`	makeItem(Integer cartLocation, String productId, BigDecimal selectedAmount, BigDecimal quantity, BigDecimal unitPrice, Timestamp reservStart, BigDecimal reservLength, BigDecimal reservPersons, Timestamp shipBeforeDate, Timestamp shipAfterDate, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool, Boolean triggerPriceRulesBool, String parentProductId, Boolean skipInventoryChecks, Boolean skipProductChecks) Makes a ShoppingCartItem and adds it to the cart.
`static ShoppingCartItem`	`makeItem(Integer cartLocation, String itemType, String itemDescription, String productCategoryId, BigDecimal basePrice, BigDecimal selectedAmount, BigDecimal quantity, Map<String,Object> attributes, String prodCatalogId, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, Boolean triggerExternalOpsBool)` Makes a non-product ShoppingCartItem and adds it to the cart.
`static ShoppingCartItem`	`makePurchaseOrderItem(Integer cartLocation, String productId, BigDecimal selectedAmount, BigDecimal quantity, Map<String,GenericValue> additionalProductFeatureAndAppls, Map<String,Object> attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, ShoppingCart.ShoppingCartItemGroup itemGroup, LocalDispatcher dispatcher, ShoppingCart cart, GenericValue supplierProduct, Timestamp shipBeforeDate, Timestamp shipAfterDate, Timestamp cancelBackOrderDate)` Makes a ShoppingCartItem for a purchase order item and adds it to the cart.
`void`	`putAdditionalProductFeatureAndAppl(GenericValue additionalProductFeatureAndAppl)`
`GenericValue`	`removeAdditionalProductFeatureAndAppl(String productFeatureTypeId)`
`void`	`removeAdjustment(GenericValue adjustment)`
`void`	`removeAdjustment(int index)`
`void`	`removeAttribute(String name)` Removes an item attribute.
`String`	`removeContactMech(String contactMechPurposeTypeId)` Remove the contactMechId from this item given the contactMechPurposeTypeId
`void`	`removeFeatureAdjustment(String productFeatureId)`
`void`	`removeOrderItemAttribute(String name)` Remove an OrderItemAttribute.
`void`	`resetPromoRuleUse(String productPromoId, String productPromoRuleId)`
`void`	`setAccommodationId(String accommodationMapId, String accommodationSpotId)` Sets accommodationId using the reservation
`void`	`setAlternativeOptionProductIds(List<String> alternativeOptionProductIds)`
`void`	`setAssociatedOrderId(String associatedOrderId)` Sets the associatedOrderId.
`void`	`setAssociatedOrderItemSeqId(String associatedOrderItemSeqId)` Sets the associatedOrderItemSeqId.
`void`	`setAttribute(String name, Object value)` Sets an item attribute.
`void`	`setBasePrice(BigDecimal basePrice)` Sets the base price for the item; use with caution
`void`	`setCancelBackOrderDate(Timestamp date)` Sets the cancel back order date
`void`	`setDesiredDeliveryDate(Timestamp ddDate)` Sets the item's customer desired delivery date.
`void`	`setDisplayPrice(BigDecimal displayPrice)` Sets the display price for the item; use with caution
`void`	`setEstimatedShipDate(Timestamp date)` Sets the date to EstimatedShipDate
`void`	`setExternalId(String externalId)`
`void`	`setIsModifiedPrice(boolean isModifiedPrice)` Set isModifiedPrice
`void`	`setIsPromo(boolean isPromo)`
`void`	`setItemComment(String itemComment)` Sets the item comment.
`void`	`setItemGroup(ShoppingCart.ShoppingCartItemGroup itemGroup)` Sets the item group.
`void`	`setItemGroup(String groupNumber, ShoppingCart cart)` Sets the item group.
`void`	`setItemType(String itemType)` Sets the item type.
`void`	`setListPrice(BigDecimal listPrice)`
`protected void`	`setLocale(Locale locale)` Set the item's locale (from ShoppingCart.setLocale)
`void`	`setName(String itemName)` Set the item's description.
`void`	`setOrderItemAssocTypeId(String orderItemAssocTypeId)` Sets the orderItemAssocTypeId.
`void`	`setOrderItemAttribute(String name, String value)` Creates an OrderItemAttribute entry.
`void`	`setOrderItemSeqId(String orderItemSeqId)`
`void`	`setProductCategoryId(String productCategoryId)`
`void`	`setQuantity(BigDecimal quantity, LocalDispatcher dispatcher, ShoppingCart cart)` Sets the quantity for the item and validates the change in quantity, etc
`void`	`setQuantity(BigDecimal quantity, LocalDispatcher dispatcher, ShoppingCart cart, boolean triggerExternalOps)` Sets the quantity for the item and validates the change in quantity, etc
`void`	`setQuantity(BigDecimal quantity, LocalDispatcher dispatcher, ShoppingCart cart, boolean triggerExternalOps, boolean resetShipGroup)` Sets the quantity for the item and validates the change in quantity, etc
`void`	`setQuantity(BigDecimal quantity, LocalDispatcher dispatcher, ShoppingCart cart, boolean triggerExternalOps, boolean resetShipGroup, boolean updateProductPrice)` Sets the quantity for the item and validates the change in quantity, etc
`protected void`	`setQuantity(BigDecimal quantity, LocalDispatcher dispatcher, ShoppingCart cart, boolean triggerExternalOps, boolean resetShipGroup, boolean updateProductPrice, boolean skipInventoryChecks)`
`void`	`setQuoteId(String quoteId)` Sets the quoteId.
`void`	`setQuoteItemSeqId(String quoteItemSeqId)` Sets the quoteItemSeqId.
`void`	`setRecurringBasePrice(BigDecimal recurringBasePrice)` Sets the base price for the item; use with caution
`void`	`setRecurringDisplayPrice(BigDecimal recurringDisplayPrice)` Sets the display price for the item; use with caution
`void`	`setRequirementId(String requirementId)` Sets the requirementId.
`void`	`setReserv2ndPPPerc(BigDecimal reserv2ndPPPerc)` Sets the extra % for second person
`void`	`setReserveAfterDate(Timestamp date)` Sets the date to ship after
`void`	`setReservLength(BigDecimal reservLength)` Sets the reservation length
`void`	`setReservNthPPPerc(BigDecimal reservNthPPPerc)` Sets the extra % for third and following person
`void`	`setReservPersons(BigDecimal reservPersons)` Sets number of persons using the reservation
`void`	`setReservStart(Timestamp reservStart)` Sets the reservation start date
`void`	`setSelectedAmount(BigDecimal selectedAmount)` Sets the user selected amount
`void`	`setShipAfterDate(Timestamp date)` Sets the date to ship after
`void`	`setShipBeforeDate(Timestamp date)` Sets the date to ship before
`void`	`setShoppingList(String shoppingListId, String itemSeqId)`
`void`	`setSpecialPromoPrice(BigDecimal specialPromoPrice)`
`void`	`setStatusId(String statusId)`
`void`	`setSupplierProductId(String supplierProductId)` Set the item's supplierProductId.
`boolean`	`shippingApplies()` Returns true if shipping charges apply to this item.
`boolean`	`taxApplies()` Returns true if tax charges apply to this item.
`void`	`updatePrice(LocalDispatcher dispatcher, ShoppingCart cart)`

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

Field Detail

module
```
public static final String module
```

resource
```
public static final String resource
```
See Also:

Constant Field Values

resource_error

public static final String resource_error

See Also:: Constant Field Values

attributeNames

protected static final String[] attributeNames

generalRounding

public static final MathContext generalRounding

Constructor Detail

ShoppingCartItem

public ShoppingCartItem(ShoppingCartItem item)

Clone an item.

ShoppingCartItem
```
protected ShoppingCartItem()
```
Cannot create shopping cart item with no parameters

ShoppingCartItem

@Deprecated
protected ShoppingCartItem(GenericValue product,
                                       Map<String,GenericValue> additionalProductFeatureAndAppls,
                                       Map<String,Object> attributes,
                                       String prodCatalogId,
                                       Locale locale,
                                       String itemType,
                                       ShoppingCart.ShoppingCartItemGroup itemGroup)

Deprecated. Use #ShoppingCartItem(GenericValue, Map, Map, String, Locale, String, ShoppingCartItemGroup, LocalDispatcher) instead

Creates new ShoppingCartItem object.

ShoppingCartItem

protected ShoppingCartItem(GenericValue product,
                           Map<String,GenericValue> additionalProductFeatureAndAppls,
                           Map<String,Object> attributes,
                           String prodCatalogId,
                           Locale locale,
                           String itemType,
                           ShoppingCart.ShoppingCartItemGroup itemGroup,
                           LocalDispatcher dispatcher)

Creates new ShoppingCartItem object.

Parameters:: dispatcher - TODO

ShoppingCartItem

protected ShoppingCartItem(GenericValue product,
                           Map<String,GenericValue> additionalProductFeatureAndAppls,
                           Map<String,Object> attributes,
                           String prodCatalogId,
                           ProductConfigWrapper configWrapper,
                           Locale locale,
                           String itemType,
                           ShoppingCart.ShoppingCartItemGroup itemGroup,
                           GenericValue parentProduct)

Creates new ShoppingCartItem object.

ShoppingCartItem

protected ShoppingCartItem(Delegator delegator,
                           String itemTypeId,
                           String description,
                           String categoryId,
                           BigDecimal basePrice,
                           Map<String,Object> attributes,
                           String prodCatalogId,
                           Locale locale,
                           ShoppingCart.ShoppingCartItemGroup itemGroup)

Creates new ShopingCartItem object.

Method Detail

makePurchaseOrderItem

public static ShoppingCartItem makePurchaseOrderItem(Integer cartLocation,
                                                     String productId,
                                                     BigDecimal selectedAmount,
                                                     BigDecimal quantity,
                                                     Map<String,GenericValue> additionalProductFeatureAndAppls,
                                                     Map<String,Object> attributes,
                                                     String prodCatalogId,
                                                     ProductConfigWrapper configWrapper,
                                                     String itemType,
                                                     ShoppingCart.ShoppingCartItemGroup itemGroup,
                                                     LocalDispatcher dispatcher,
                                                     ShoppingCart cart,
                                                     GenericValue supplierProduct,
                                                     Timestamp shipBeforeDate,
                                                     Timestamp shipAfterDate,
                                                     Timestamp cancelBackOrderDate)
                                              throws CartItemModifyException,
                                                     ItemNotFoundException

Makes a ShoppingCartItem for a purchase order item and adds it to the cart. NOTE: This method will get the product entity and check to make sure it can be purchased.

Parameters:: cartLocation - The location to place this item; null will place at the end; productId - The primary key of the product being added; quantity - The quantity to add; additionalProductFeatureAndAppls - Product feature/appls map; attributes - All unique attributes for this item (NOT features); prodCatalogId - The catalog this item was added from; configWrapper - The product configuration wrapper (null if the product is not configurable); dispatcher - LocalDispatcher object for doing promotions, etc; cart - The parent shopping cart object this item will belong to; supplierProduct - GenericValue of SupplierProduct entity, containing product description and prices; shipBeforeDate - Request that the shipment be made before this date; shipAfterDate - Request that the shipment be made after this date; cancelBackOrderDate - The date which if crossed causes order cancellation
Returns:: a new ShoppingCartItem object
Throws:: CartItemModifyException; ItemNotFoundException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        String productId,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        BigDecimal unitPrice,
                                        Timestamp reservStart,
                                        BigDecimal reservLength,
                                        BigDecimal reservPersons,
                                        Timestamp shipBeforeDate,
                                        Timestamp shipAfterDate,
                                        Map<String,GenericValue> additionalProductFeatureAndAppls,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ProductConfigWrapper configWrapper,
                                        String itemType,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool,
                                        Boolean triggerPriceRulesBool,
                                        String parentProductId,
                                        Boolean skipInventoryChecks,
                                        Boolean skipProductChecks)
                                 throws CartItemModifyException,
                                        ItemNotFoundException

Makes a ShoppingCartItem and adds it to the cart. NOTE: This method will get the product entity and check to make sure it can be purchased.

Parameters:: cartLocation - The location to place this item; null will place at the end; productId - The primary key of the product being added; selectedAmount - Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here.; quantity - Required. The quantity to add.; unitPrice - Optional. Defaults to 0.0, which causes calculation of price.; reservStart - Optional. The start of the reservation.; reservLength - Optional. The length of the reservation.; reservPersons - Optional. The number of persons taking advantage of the reservation.; shipBeforeDate - Optional. The date to ship the order by.; shipAfterDate - Optional. Wait until this date to ship.; additionalProductFeatureAndAppls - Optional. Product feature/appls map.; attributes - Optional. All unique attributes for this item (NOT features).; prodCatalogId - Optional, but strongly recommended. The catalog this item was added from.; configWrapper - Optional. The product configuration wrapper (null if the product is not configurable).; itemType - Optional. Specifies the type of cart item, corresponds to an OrderItemType and should be a valid orderItemTypeId.; itemGroup - Optional. Specifies which item group in the cart this should belong to, if item groups are needed/desired.; dispatcher - Required (for price calculation, promos, etc). LocalDispatcher object for doing promotions, etc.; cart - Required. The parent shopping cart object this item will belong to.; triggerExternalOpsBool - Optional. Defaults to true. Trigger external operations (like promotions and such)?; triggerPriceRulesBool - Optional. Defaults to true. Trigger the price rules to calculate the price for this item?
Returns:: a new ShoppingCartItem object
Throws:: CartItemModifyException; ItemNotFoundException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        String productId,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        BigDecimal unitPrice,
                                        Timestamp reservStart,
                                        BigDecimal reservLength,
                                        BigDecimal reservPersons,
                                        String accommodationMapId,
                                        String accommodationSpotId,
                                        Timestamp shipBeforeDate,
                                        Timestamp shipAfterDate,
                                        Map<String,GenericValue> additionalProductFeatureAndAppls,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ProductConfigWrapper configWrapper,
                                        String itemType,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool,
                                        Boolean triggerPriceRulesBool,
                                        String parentProductId,
                                        Boolean skipInventoryChecks,
                                        Boolean skipProductChecks)
                                 throws CartItemModifyException,
                                        ItemNotFoundException

Throws:: CartItemModifyException; ItemNotFoundException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        String productId,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        BigDecimal unitPrice,
                                        Timestamp reservStart,
                                        BigDecimal reservLength,
                                        BigDecimal reservPersons,
                                        String accommodationMapId,
                                        String accommodationSpotId,
                                        Timestamp shipBeforeDate,
                                        Timestamp shipAfterDate,
                                        Timestamp reserveAfterDate,
                                        Map<String,GenericValue> additionalProductFeatureAndAppls,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ProductConfigWrapper configWrapper,
                                        String itemType,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool,
                                        Boolean triggerPriceRulesBool,
                                        String parentProductId,
                                        Boolean skipInventoryChecks,
                                        Boolean skipProductChecks)
                                 throws CartItemModifyException,
                                        ItemNotFoundException

Makes a ShoppingCartItem and adds it to the cart.

Parameters:: accommodationMapId - Optional. reservations add into workeffort; accommodationSpotId - Optional. reservations add into workeffort
Throws:: CartItemModifyException; ItemNotFoundException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        GenericValue product,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        BigDecimal unitPrice,
                                        Timestamp reservStart,
                                        BigDecimal reservLength,
                                        BigDecimal reservPersons,
                                        Timestamp shipBeforeDate,
                                        Timestamp shipAfterDate,
                                        Map<String,GenericValue> additionalProductFeatureAndAppls,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ProductConfigWrapper configWrapper,
                                        String itemType,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool,
                                        Boolean triggerPriceRulesBool,
                                        GenericValue parentProduct,
                                        Boolean skipInventoryChecks,
                                        Boolean skipProductChecks)
                                 throws CartItemModifyException

Makes a ShoppingCartItem and adds it to the cart. WARNING: This method does not check if the product is in a purchase category. rental fields were added.

Parameters:: cartLocation - The location to place this item; null will place at the end; product - The product entity relating to the product being added; selectedAmount - Optional. Defaults to 0.0. If a selectedAmount is needed (complements the quantity value), pass it in here.; quantity - Required. The quantity to add.; unitPrice - Optional. Defaults to 0.0, which causes calculation of price.; reservStart - Optional. The start of the reservation.; reservLength - Optional. The length of the reservation.; reservPersons - Optional. The number of persons taking advantage of the reservation.; shipBeforeDate - Optional. The date to ship the order by.; shipAfterDate - Optional. Wait until this date to ship.; additionalProductFeatureAndAppls - Optional. Product feature/appls map.; attributes - Optional. All unique attributes for this item (NOT features).; prodCatalogId - Optional, but strongly recommended. The catalog this item was added from.; configWrapper - Optional. The product configuration wrapper (null if the product is not configurable).; itemType - Optional. Specifies the type of cart item, corresponds to an OrderItemType and should be a valid orderItemTypeId.; itemGroup - Optional. Specifies which item group in the cart this should belong to, if item groups are needed/desired.; dispatcher - Required (for price calculation, promos, etc). LocalDispatcher object for doing promotions, etc.; cart - Required. The parent shopping cart object this item will belong to.; triggerExternalOpsBool - Optional. Defaults to true. Trigger external operations (like promotions and such)?; triggerPriceRulesBool - Optional. Defaults to true. Trigger the price rules to calculate the price for this item?
Returns:: a new ShoppingCartItem object
Throws:: CartItemModifyException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        GenericValue product,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        BigDecimal unitPrice,
                                        Timestamp reservStart,
                                        BigDecimal reservLength,
                                        BigDecimal reservPersons,
                                        String accommodationMapId,
                                        String accommodationSpotId,
                                        Timestamp shipBeforeDate,
                                        Timestamp shipAfterDate,
                                        Timestamp reserveAfterDate,
                                        Map<String,GenericValue> additionalProductFeatureAndAppls,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ProductConfigWrapper configWrapper,
                                        String itemType,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool,
                                        Boolean triggerPriceRulesBool,
                                        GenericValue parentProduct,
                                        Boolean skipInventoryChecks,
                                        Boolean skipProductChecks)
                                 throws CartItemModifyException

Makes a ShoppingCartItem and adds it to the cart.

Parameters:: accommodationMapId - Optional. reservations add into workeffort; accommodationSpotId - Optional. reservations add into workeffort
Throws:: CartItemModifyException

findProduct

public static GenericValue findProduct(Delegator delegator,
                                       boolean skipProductChecks,
                                       String prodCatalogId,
                                       String productId,
                                       Locale locale)
                                throws ItemNotFoundException

Throws:: ItemNotFoundException

isValidCartProduct

public static void isValidCartProduct(ProductConfigWrapper configWrapper,
                                      GenericValue product,
                                      Timestamp nowTimestamp,
                                      Locale locale)
                               throws CartItemModifyException

Throws:: CartItemModifyException

makeItem

public static ShoppingCartItem makeItem(Integer cartLocation,
                                        String itemType,
                                        String itemDescription,
                                        String productCategoryId,
                                        BigDecimal basePrice,
                                        BigDecimal selectedAmount,
                                        BigDecimal quantity,
                                        Map<String,Object> attributes,
                                        String prodCatalogId,
                                        ShoppingCart.ShoppingCartItemGroup itemGroup,
                                        LocalDispatcher dispatcher,
                                        ShoppingCart cart,
                                        Boolean triggerExternalOpsBool)
                                 throws CartItemModifyException

Makes a non-product ShoppingCartItem and adds it to the cart. NOTE: This is only for non-product items; items without a product entity (work items, bulk items, etc)

Parameters:: cartLocation - The location to place this item; null will place at the end; itemType - The OrderItemTypeId for the item being added; itemDescription - The optional description of the item; productCategoryId - The optional category the product *will* go in; basePrice - The price for this item; selectedAmount -; quantity - The quantity to add; attributes - All unique attributes for this item (NOT features); prodCatalogId - The catalog this item was added from; dispatcher - LocalDispatcher object for doing promotions, etc; cart - The parent shopping cart object this item will belong to; triggerExternalOpsBool - Indicates if we should run external operations (promotions, auto-save, etc)
Returns:: a new ShoppingCartItem object
Throws:: CartItemModifyException

getProdCatalogId
```
public String getProdCatalogId()
```

setExternalId

public void setExternalId(String externalId)

getExternalId
```
public String getExternalId()
```

setSelectedAmount

public void setSelectedAmount(BigDecimal selectedAmount)

Sets the user selected amount

getSelectedAmount
```
public BigDecimal getSelectedAmount()
```
Returns the user selected amount

setBasePrice
```
public void setBasePrice(BigDecimal basePrice)
```
Sets the base price for the item; use with caution

setDisplayPrice
```
public void setDisplayPrice(BigDecimal displayPrice)
```
Sets the display price for the item; use with caution

setRecurringBasePrice
```
public void setRecurringBasePrice(BigDecimal recurringBasePrice)
```
Sets the base price for the item; use with caution

setRecurringDisplayPrice
```
public void setRecurringDisplayPrice(BigDecimal recurringDisplayPrice)
```
Sets the display price for the item; use with caution

setSpecialPromoPrice

public void setSpecialPromoPrice(BigDecimal specialPromoPrice)

setReserv2ndPPPerc

public void setReserv2ndPPPerc(BigDecimal reserv2ndPPPerc)

Sets the extra % for second person

setReservNthPPPerc
```
public void setReservNthPPPerc(BigDecimal reservNthPPPerc)
```
Sets the extra % for third and following person

setReservStart

public void setReservStart(Timestamp reservStart)

Sets the reservation start date

setReservLength

public void setReservLength(BigDecimal reservLength)

Sets the reservation length

setReservPersons
```
public void setReservPersons(BigDecimal reservPersons)
```
Sets number of persons using the reservation

setAccommodationId

public void setAccommodationId(String accommodationMapId,
                               String accommodationSpotId)

Sets accommodationId using the reservation

setQuantity

public void setQuantity(BigDecimal quantity,
                        LocalDispatcher dispatcher,
                        ShoppingCart cart)
                 throws CartItemModifyException

Sets the quantity for the item and validates the change in quantity, etc

Throws:: CartItemModifyException

setQuantity

public void setQuantity(BigDecimal quantity,
                        LocalDispatcher dispatcher,
                        ShoppingCart cart,
                        boolean triggerExternalOps)
                 throws CartItemModifyException

Sets the quantity for the item and validates the change in quantity, etc

Throws:: CartItemModifyException

setQuantity

public void setQuantity(BigDecimal quantity,
                        LocalDispatcher dispatcher,
                        ShoppingCart cart,
                        boolean triggerExternalOps,
                        boolean resetShipGroup)
                 throws CartItemModifyException

Sets the quantity for the item and validates the change in quantity, etc

Throws:: CartItemModifyException

setQuantity

public void setQuantity(BigDecimal quantity,
                        LocalDispatcher dispatcher,
                        ShoppingCart cart,
                        boolean triggerExternalOps,
                        boolean resetShipGroup,
                        boolean updateProductPrice)
                 throws CartItemModifyException

Sets the quantity for the item and validates the change in quantity, etc

Throws:: CartItemModifyException

checkAvailability

public static String checkAvailability(String productId,
                                       BigDecimal quantity,
                                       Timestamp reservStart,
                                       BigDecimal reservLength,
                                       ShoppingCart cart)

returns "OK" when the product can be booked or returns a string with the dates the related fixed Asset is not available

isInventoryAvailableOrNotRequired

protected boolean isInventoryAvailableOrNotRequired(BigDecimal quantity,
                                                    String productStoreId,
                                                    LocalDispatcher dispatcher)
                                             throws CartItemModifyException

Throws:: CartItemModifyException

setQuantity

protected void setQuantity(BigDecimal quantity,
                           LocalDispatcher dispatcher,
                           ShoppingCart cart,
                           boolean triggerExternalOps,
                           boolean resetShipGroup,
                           boolean updateProductPrice,
                           boolean skipInventoryChecks)
                    throws CartItemModifyException

Throws:: CartItemModifyException

calcDepositAdjustments
```
public void calcDepositAdjustments()
```

updatePrice

public void updatePrice(LocalDispatcher dispatcher,
                        ShoppingCart cart)
                 throws CartItemModifyException

Throws:: CartItemModifyException

getQuantity
```
public BigDecimal getQuantity()
```
Returns the quantity.

getReservStart
```
public Timestamp getReservStart()
```
Returns the reservation start date.

getReservStart
```
public Timestamp getReservStart(BigDecimal addDays)
```
Returns the reservation start date with a number of days added.

getReservLength
```
public BigDecimal getReservLength()
```
Returns the reservation length.

getReservPersons
```
public BigDecimal getReservPersons()
```
Returns the reservation number of persons.

getAccommodationMapId
```
public String getAccommodationMapId()
```
Returns accommodationMapId

getAccommodationSpotId
```
public String getAccommodationSpotId()
```
Returns accommodationSpotId

getPromoQuantityUsed

public BigDecimal getPromoQuantityUsed()

getPromoQuantityAvailable

public BigDecimal getPromoQuantityAvailable()

getQuantityUsedPerPromoActualIter

public Iterator<Map.Entry<GenericPK,BigDecimal>> getQuantityUsedPerPromoActualIter()

getQuantityUsedPerPromoCandidateIter

public Iterator<Map.Entry<GenericPK,BigDecimal>> getQuantityUsedPerPromoCandidateIter()

getQuantityUsedPerPromoFailedIter

public Iterator<Map.Entry<GenericPK,BigDecimal>> getQuantityUsedPerPromoFailedIter()

addPromoQuantityCandidateUse

public BigDecimal addPromoQuantityCandidateUse(BigDecimal quantityDesired,
                                               GenericValue productPromoCondAction,
                                               boolean checkAvailableOnly)

getPromoQuantityCandidateUse

public BigDecimal getPromoQuantityCandidateUse(GenericValue productPromoCondAction)

getPromoQuantityCandidateUseActionAndAllConds

public BigDecimal getPromoQuantityCandidateUseActionAndAllConds(GenericValue productPromoAction)

resetPromoRuleUse

public void resetPromoRuleUse(String productPromoId,
                              String productPromoRuleId)

confirmPromoRuleUse

public void confirmPromoRuleUse(String productPromoId,
                                String productPromoRuleId)

clearPromoRuleUseInfo
```
public void clearPromoRuleUseInfo()
```

setItemComment

public void setItemComment(String itemComment)

Sets the item comment.

getItemComment
```
public String getItemComment()
```
Returns the item's comment.

setDesiredDeliveryDate
```
public void setDesiredDeliveryDate(Timestamp ddDate)
```
Sets the item's customer desired delivery date.

getDesiredDeliveryDate
```
public Timestamp getDesiredDeliveryDate()
```
Returns the item's customer desired delivery date.

setShipBeforeDate

public void setShipBeforeDate(Timestamp date)

Sets the date to ship before

getShipBeforeDate
```
public Timestamp getShipBeforeDate()
```
Returns the date to ship before

setShipAfterDate

public void setShipAfterDate(Timestamp date)

Sets the date to ship after

getShipAfterDate
```
public Timestamp getShipAfterDate()
```
Returns the date to ship after

setReserveAfterDate

public void setReserveAfterDate(Timestamp date)

Sets the date to ship after

getReserveAfterDate
```
public Timestamp getReserveAfterDate()
```
Returns the date to ship after

setCancelBackOrderDate

public void setCancelBackOrderDate(Timestamp date)

Sets the cancel back order date

getCancelBackOrderDate
```
public Timestamp getCancelBackOrderDate()
```
Returns the cancel back order date

setEstimatedShipDate
```
public void setEstimatedShipDate(Timestamp date)
```
Sets the date to EstimatedShipDate

getEstimatedShipDate
```
public Timestamp getEstimatedShipDate()
```
Returns the date to EstimatedShipDate

setItemType

public void setItemType(String itemType)

Sets the item type.

getItemType
```
public String getItemType()
```
Returns the item type.

getItemTypeGenericValue

public GenericValue getItemTypeGenericValue()

Returns the item type.

setItemGroup

public void setItemGroup(ShoppingCart.ShoppingCartItemGroup itemGroup)

Sets the item group.

setItemGroup

public void setItemGroup(String groupNumber,
                         ShoppingCart cart)

Sets the item group.

getItemGroup

public ShoppingCart.ShoppingCartItemGroup getItemGroup()

Returns the item group.

isInItemGroup

public boolean isInItemGroup(String groupNumber)

getItemTypeDescription
```
public String getItemTypeDescription()
```
Returns the item type description.

getProductCategoryId
```
public String getProductCategoryId()
```
Returns the productCategoryId for the item or null if none.

setProductCategoryId

public void setProductCategoryId(String productCategoryId)

setOrderItemSeqId

public void setOrderItemSeqId(String orderItemSeqId)

getOrderItemSeqId
```
public String getOrderItemSeqId()
```

setShoppingList

public void setShoppingList(String shoppingListId,
                            String itemSeqId)

getShoppingListId
```
public String getShoppingListId()
```

getShoppingListItemSeqId

public String getShoppingListItemSeqId()

setRequirementId

public void setRequirementId(String requirementId)

Sets the requirementId.

getRequirementId
```
public String getRequirementId()
```
Returns the requirementId.

setQuoteId

public void setQuoteId(String quoteId)

Sets the quoteId.

getQuoteId
```
public String getQuoteId()
```
Returns the quoteId.

setQuoteItemSeqId

public void setQuoteItemSeqId(String quoteItemSeqId)

Sets the quoteItemSeqId.

getQuoteItemSeqId
```
public String getQuoteItemSeqId()
```
Returns the quoteItemSeqId.

setOrderItemAssocTypeId

public void setOrderItemAssocTypeId(String orderItemAssocTypeId)

Sets the orderItemAssocTypeId.

getOrderItemAssocTypeId
```
public String getOrderItemAssocTypeId()
```
Returns the OrderItemAssocTypeId.

setAssociatedOrderId

public void setAssociatedOrderId(String associatedOrderId)

Sets the associatedOrderId.

getAssociatedOrderId
```
public String getAssociatedOrderId()
```
Returns the associatedId.

setAssociatedOrderItemSeqId

public void setAssociatedOrderItemSeqId(String associatedOrderItemSeqId)

Sets the associatedOrderItemSeqId.

getAssociatedOrderItemSeqId
```
public String getAssociatedOrderItemSeqId()
```
Returns the associatedOrderItemSeqId.

getStatusId
```
public String getStatusId()
```

setStatusId

public void setStatusId(String statusId)

shippingApplies
```
public boolean shippingApplies()
```
Returns true if shipping charges apply to this item.

taxApplies
```
public boolean taxApplies()
```
Returns true if tax charges apply to this item.

getProductId
```
public String getProductId()
```
Returns the item's productId.

getSupplierProductId
```
public String getSupplierProductId()
```
Returns the item's supplierProductId.

setSupplierProductId

public void setSupplierProductId(String supplierProductId)

Set the item's supplierProductId.

setLocale
```
protected void setLocale(Locale locale)
```
Set the item's locale (from ShoppingCart.setLocale)

setName
```
public void setName(String itemName)
```
Set the item's description.

getName
```
@Deprecated
public String getName()
```
Deprecated. use getName(LocalDispatcher dispatcher)

Returns the item's description.

getName
```
public String getName(LocalDispatcher dispatcher)
```
Returns the item's description or PRODUCT_NAME from content.

getDescription

public String getDescription(LocalDispatcher dispatcher)

Returns the item's description.

getConfigWrapper

public ProductConfigWrapper getConfigWrapper()

getWeight
```
public BigDecimal getWeight()
```
Returns the item's unit weight

getPiecesIncluded
```
public long getPiecesIncluded()
```
Returns the item's pieces included

getFeatureSet
```
public Set<String> getFeatureSet()
```
Returns a Set of the item's features

getStandardFeatureList
```
public List<GenericValue> getStandardFeatureList()
```
Returns a list of the item's standard features

getFeaturesForSupplier

public List<GenericValue> getFeaturesForSupplier(LocalDispatcher dispatcher,
                                                 String partyId)

Returns a List of the item's features for supplier

getSize
```
public BigDecimal getSize()
```
Returns the item's size (length + girth)

getItemProductInfo

public Map<String,Object> getItemProductInfo()

getBasePrice
```
public BigDecimal getBasePrice()
```
Returns the base price.

getDisplayPrice
```
public BigDecimal getDisplayPrice()
```

getSpecialPromoPrice

public BigDecimal getSpecialPromoPrice()

getRecurringBasePrice

public BigDecimal getRecurringBasePrice()

getRecurringDisplayPrice

public BigDecimal getRecurringDisplayPrice()

getListPrice
```
public BigDecimal getListPrice()
```
Returns the list price.

setListPrice

public void setListPrice(BigDecimal listPrice)

getIsModifiedPrice
```
public boolean getIsModifiedPrice()
```
Returns isModifiedPrice

setIsModifiedPrice

public void setIsModifiedPrice(boolean isModifiedPrice)

Set isModifiedPrice

getReserv2ndPPPerc
```
public BigDecimal getReserv2ndPPPerc()
```
get the percentage for the second person

getReservNthPPPerc
```
public BigDecimal getReservNthPPPerc()
```
get the percentage for the third and following person

getOtherAdjustments
```
public BigDecimal getOtherAdjustments()
```
Returns the "other" adjustments.

getOtherAdjustmentsRecurring
```
public BigDecimal getOtherAdjustmentsRecurring()
```
Returns the "other" adjustments.

getRentalAdjustment
```
public BigDecimal getRentalAdjustment()
```
calculates for a reservation the percentage/100 extra for more than 1 person.

getItemSubTotal

public BigDecimal getItemSubTotal(BigDecimal quantity)

Returns the total line price.

getItemSubTotal
```
public BigDecimal getItemSubTotal()
```

getDisplayItemSubTotal

public BigDecimal getDisplayItemSubTotal()

getDisplayItemSubTotalNoAdj

public BigDecimal getDisplayItemSubTotalNoAdj()

getDisplayItemRecurringSubTotal

public BigDecimal getDisplayItemRecurringSubTotal()

getDisplayItemRecurringSubTotalNoAdj

public BigDecimal getDisplayItemRecurringSubTotalNoAdj()

addAllProductFeatureAndAppls

public void addAllProductFeatureAndAppls(Map<String,GenericValue> productFeatureAndApplsToAdd)

putAdditionalProductFeatureAndAppl

public void putAdditionalProductFeatureAndAppl(GenericValue additionalProductFeatureAndAppl)

getAdditionalProductFeatureAndAppl

public GenericValue getAdditionalProductFeatureAndAppl(String productFeatureTypeId)

removeAdditionalProductFeatureAndAppl

public GenericValue removeAdditionalProductFeatureAndAppl(String productFeatureTypeId)

getAdditionalProductFeatureAndAppls

public Map<String,GenericValue> getAdditionalProductFeatureAndAppls()

getFeatureIdQtyMap

public Map<String,BigDecimal> getFeatureIdQtyMap(BigDecimal quantity)

removeAttribute

public void removeAttribute(String name)

Removes an item attribute.

setAttribute

public void setAttribute(String name,
                         Object value)

Sets an item attribute.

getAttribute

public Object getAttribute(String name)

Return a specific attribute.

getAttributes
```
public Map<String,Object> getAttributes()
```
Returns the attributes for the item.

removeOrderItemAttribute

public void removeOrderItemAttribute(String name)

Remove an OrderItemAttribute.

setOrderItemAttribute

public void setOrderItemAttribute(String name,
                                  String value)

Creates an OrderItemAttribute entry.

getOrderItemAttribute

public String getOrderItemAttribute(String name)

Return an OrderItemAttribute.

getOrderItemAttributes

public Map<String,String> getOrderItemAttributes()

addAdjustment
```
public int addAdjustment(GenericValue adjustment)
```
Add an adjustment to the order item; don't worry about setting the orderId, orderItemSeqId or orderAdjustmentId; they will be set when the order is created

removeAdjustment

public void removeAdjustment(GenericValue adjustment)

removeAdjustment

public void removeAdjustment(int index)

getAdjustments

public List<GenericValue> getAdjustments()

removeFeatureAdjustment

public void removeFeatureAdjustment(String productFeatureId)

getOrderItemPriceInfos

public List<GenericValue> getOrderItemPriceInfos()

addContactMech

public void addContactMech(String contactMechPurposeTypeId,
                           String contactMechId)

Add a contact mech to this purpose; the contactMechPurposeTypeId is required

getContactMech
```
public String getContactMech(String contactMechPurposeTypeId)
```
Get the contactMechId for this item given the contactMechPurposeTypeId

removeContactMech
```
public String removeContactMech(String contactMechPurposeTypeId)
```
Remove the contactMechId from this item given the contactMechPurposeTypeId

getOrderItemContactMechIds

public Map<String,String> getOrderItemContactMechIds()

setIsPromo

public void setIsPromo(boolean isPromo)

getIsPromo
```
public boolean getIsPromo()
```

getAlternativeOptionProductIds

public List<String> getAlternativeOptionProductIds()

setAlternativeOptionProductIds

public void setAlternativeOptionProductIds(List<String> alternativeOptionProductIds)

equals

public boolean equals(ShoppingCartItem item)

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals

public boolean equals(String productId,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      String prodCatalogId,
                      BigDecimal selectedAmount)

Compares the specified object with this cart item. Defaults isPromo to false. Default to no itemGroup.

equals

public boolean equals(String productId,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      String prodCatalogId,
                      ProductConfigWrapper configWrapper,
                      String itemType,
                      ShoppingCart.ShoppingCartItemGroup itemGroup,
                      BigDecimal selectedAmount)

Compares the specified object with this cart item. Defaults isPromo to false.

equals

public boolean equals(String productId,
                      Timestamp reservStart,
                      BigDecimal reservLength,
                      BigDecimal reservPersons,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      String prodCatalogId,
                      ProductConfigWrapper configWrapper,
                      String itemType,
                      ShoppingCart.ShoppingCartItemGroup itemGroup,
                      BigDecimal selectedAmount)

Compares the specified object with this cart item including rental data. Defaults isPromo to false.

equals

public boolean equals(String productId,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      String prodCatalogId,
                      BigDecimal selectedAmount,
                      String itemType,
                      ShoppingCart.ShoppingCartItemGroup itemGroup,
                      boolean isPromo)

Compares the specified object with this cart item. Defaults isPromo to false.

equals

public boolean equals(String productId,
                      Timestamp reservStart,
                      BigDecimal reservLength,
                      BigDecimal reservPersons,
                      String accommodationMapId,
                      String accommodationSpotId,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      String prodCatalogId,
                      BigDecimal selectedAmount,
                      ProductConfigWrapper configWrapper,
                      String itemType,
                      ShoppingCart.ShoppingCartItemGroup itemGroup,
                      boolean isPromo)

Compares the specified object with this cart item.

equals

public boolean equals(String productId,
                      Timestamp reservStart,
                      BigDecimal reservLength,
                      BigDecimal reservPersons,
                      String accommodationMapId,
                      String accommodationSpotId,
                      Map<String,GenericValue> additionalProductFeatureAndAppls,
                      Map<String,Object> attributes,
                      Map<String,String> orderItemAttributes,
                      String prodCatalogId,
                      BigDecimal selectedAmount,
                      ProductConfigWrapper configWrapper,
                      String itemType,
                      ShoppingCart.ShoppingCartItemGroup itemGroup,
                      boolean isPromo)

Compares the specified object order item attributes.

getProduct
```
public GenericValue getProduct()
```
Gets the Product entity. If it is not already retreived gets it from the delegator

getParentProduct

public GenericValue getParentProduct()

getParentProductId
```
public String getParentProductId()
```

getOptionalProductFeatures

public Map<String,List<GenericValue>> getOptionalProductFeatures()

getDelegator
```
public Delegator getDelegator()
```

explodeItem

public List<ShoppingCartItem> explodeItem(ShoppingCart cart,
                                          LocalDispatcher dispatcher)
                                   throws CartItemModifyException

Throws:: CartItemModifyException

getPurchaseOrderItemDescription

public static String getPurchaseOrderItemDescription(GenericValue product,
                                                     GenericValue supplierProduct,
                                                     Locale locale,
                                                     LocalDispatcher dispatcher)

Class ShoppingCartItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

module

resource

resource_error

attributeNames

generalRounding

Constructor Detail

ShoppingCartItem

ShoppingCartItem

ShoppingCartItem

ShoppingCartItem

ShoppingCartItem

ShoppingCartItem

Method Detail

makePurchaseOrderItem

makeItem

makeItem

makeItem

makeItem

makeItem

findProduct

isValidCartProduct

makeItem

getProdCatalogId

setExternalId

getExternalId

setSelectedAmount

getSelectedAmount

setBasePrice

setDisplayPrice

setRecurringBasePrice

setRecurringDisplayPrice

setSpecialPromoPrice

setReserv2ndPPPerc

setReservNthPPPerc

setReservStart

setReservLength

setReservPersons

setAccommodationId

setQuantity

setQuantity

setQuantity

setQuantity

checkAvailability

isInventoryAvailableOrNotRequired

setQuantity

calcDepositAdjustments

updatePrice

getQuantity

getReservStart

getReservStart

getReservLength

getReservPersons

getAccommodationMapId

getAccommodationSpotId

getPromoQuantityUsed

getPromoQuantityAvailable

getQuantityUsedPerPromoActualIter

getQuantityUsedPerPromoCandidateIter

getQuantityUsedPerPromoFailedIter

addPromoQuantityCandidateUse

getPromoQuantityCandidateUse

getPromoQuantityCandidateUseActionAndAllConds

resetPromoRuleUse

confirmPromoRuleUse

clearPromoRuleUseInfo

setItemComment

getItemComment

setDesiredDeliveryDate

getDesiredDeliveryDate

setShipBeforeDate

getShipBeforeDate

setShipAfterDate

getShipAfterDate

setReserveAfterDate