Java Doc for ShoppingCart.java in  » ERP-CRM-Financial » ofbiz » org » ofbiz » order » shoppingcart » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » ofbiz » org.ofbiz.order.shoppingcart 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.ofbiz.order.shoppingcart.ShoppingCart

All known Subclasses:   org.ofbiz.order.shoppingcart.WebShoppingCart,
ShoppingCart
public class ShoppingCart implements Serializable(Code)
Shopping Cart Object

Inner Class :static class BasePriceOrderComparator implements Comparator,Serializable
Inner Class :public static class ShoppingCartItemGroup implements Serializable
Inner Class :public static class ProductPromoUseInfo implements Serializable
Inner Class :public static class CartShipInfo implements Serializable
Inner Class :public static class CartPaymentInfo implements Serializable,Comparable

Field Summary
final public static  BigDecimalZERO
    
protected  StringautoOrderShoppingListId
    
protected  GenericValueautoUserLogin
    
protected  StringbillFromVendorPartyId
    
protected  StringbillToCustomerPartyId
    
protected  StringcurrencyUom
    
protected  StringendUserCustomerPartyId
    
protected  StringfacilityId
    
protected  booleanholdOrder
    
protected  Localelocale
    
final public static  Stringmodule
    
protected  longnextGroupNumber
    
protected  TimestamporderDate
    
protected  StringorderPartyId
    
final public static  BigDecimalpercentage
    
protected  StringplacingCustomerPartyId
    
protected  StringproductStoreId
    
final public static  Stringresource_error
    
final public static  introunding
    
final public static  intscale
    
protected  StringshipFromVendorPartyId
    
protected  StringshipToCustomerPartyId
    
protected  StringsupplierAgentPartyId
    
final public static  inttaxCalcScale
    
final public static  inttaxFinalScale
    
final public static  inttaxRounding
    
protected  StringterminalId
    
protected  StringtransactionId
    
protected  GenericValueuserLogin
    
protected  StringwebSiteId
    

Constructor Summary
protected  ShoppingCart()
    
public  ShoppingCart(ShoppingCart cart)
     Creates a new cloned ShoppingCart Object.
public  ShoppingCart(GenericDelegator delegator, String productStoreId, String webSiteId, Locale locale, String currencyUom, String billToCustomerPartyId, String billFromVendorPartyId)
     Creates new empty ShoppingCart object.
public  ShoppingCart(GenericDelegator delegator, String productStoreId, String webSiteId, Locale locale, String currencyUom)
     Creates new empty ShoppingCart object.
public  ShoppingCart(GenericDelegator delegator, String productStoreId, Locale locale, String currencyUom)
     Creates a new empty ShoppingCart object.

Method Summary
public  voidaddAdditionalPartyRole(String partyId, String roleTypeId)
     Associates a party with a role to the order.
public  intaddAdjustment(GenericValue adjustment)
    
public  voidaddContactMech(String contactMechPurposeTypeId, String contactMechId)
    
public  voidaddFreeShippingProductPromoAction(GenericValue productPromoAction)
     Adds a ProductPromoAction to be used for free shipping (must be of type free shipping, or nothing will be done).
public  voidaddInternalOrderNote(String note)
    
public  intaddItem(int index, ShoppingCartItem item)
     Add an item to the shopping cart.
public  StringaddItemGroup(String groupName, String parentGroupNumber)
    
public  intaddItemToEnd(String productId, Double amount, double quantity, Double unitPrice, HashMap features, HashMap attributes, String prodCatalogId, String itemType, LocalDispatcher dispatcher, Boolean triggerExternalOps, Boolean triggerPriceRules)
     Add an item to the shopping cart.
public  intaddItemToEnd(String productId, Double amount, double quantity, Double unitPrice, HashMap features, HashMap attributes, String prodCatalogId, String itemType, LocalDispatcher dispatcher, Boolean triggerExternalOps, Boolean triggerPriceRules, Boolean skipInventoryChecks, Boolean skipProductChecks)
     Add an item to the shopping cart.
public  intaddItemToEnd(ShoppingCartItem item)
     Add an item to the shopping cart.
public  intaddNonProductItem(String itemType, String description, String categoryId, Double price, double quantity, Map attributes, String prodCatalogId, String itemGroupNumber, LocalDispatcher dispatcher)
     Add a non-product item to the shopping cart.
public  intaddOrIncreaseItem(String productId, Double selectedAmountDbl, double quantity, Timestamp reservStart, Double reservLengthDbl, Double reservPersonsDbl, Timestamp shipBeforeDate, Timestamp shipAfterDate, Map features, Map attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, String itemGroupNumber, String parentProductId, LocalDispatcher dispatcher)
     Add an item to the shopping cart, or if already there, increase the quantity.
public  voidaddOrderNote(String note)
    
public  intaddOrderTerm(String termTypeId, Double termValue, Long termDays)
    
public  intaddOrderTerm(String termTypeId, Double termValue, Long termDays, String description)
    
public  intaddOrderTerm(GenericValue orderTerm)
    
public  CartPaymentInfoaddPayment(String id)
    
public  CartPaymentInfoaddPaymentAmount(String id, Double amount, String refNum, String authCode, boolean isSingleUse, boolean isPresent, boolean replace)
    
public  CartPaymentInfoaddPaymentAmount(String id, Double amount, boolean isSingleUse)
    
public  CartPaymentInfoaddPaymentAmount(String id, double amount, boolean isSingleUse)
    
public  CartPaymentInfoaddPaymentAmount(String id, Double amount)
    
public  CartPaymentInfoaddPaymentAmount(String id, double amount)
    
public  voidaddPaymentRef(String id, String ref, String authCode)
    
public  StringaddProductPromoCode(String productPromoCodeId, LocalDispatcher dispatcher)
     Adds a promotion code to the cart, checking if it is valid.
public  voidaddProductPromoUse(String productPromoId, String productPromoCodeId, double totalDiscountAmount, double quantityLeftInActions)
    
public  intaddShipInfo()
    
protected  booleancheckShipItemInfo(CartShipInfo csi, CartShipInfo.CartShipItemInfo csii)
    
protected  voidcleanUpShipGroups()
    
public  voidclear()
     Clears out the cart.
public  voidclearAllAdjustments()
    
public  voidclearAllItemStatus()
    
public  voidclearAllPromotionAdjustments()
    
public  voidclearAllPromotionInformation()
    
public  voidclearCartItemUseInPromoInfo()
    
public  voidclearDeclinedPaymentMethodsFromOrder(GenericDelegator delegator, String orderId)
     remove declined payment methods for an order from cart.
public  voidclearItemShipInfo(ShoppingCartItem item)
    
public  voidclearPayment(String id)
    
public  voidclearPayment(int index)
    
public  voidclearPaymentMethodsById(List paymentMethodIdsToRemove)
    
public  voidclearPayments()
    
public  voidclearProductPromoUseInfo()
    
public synchronized  voidconfirmPromoRuleUse(String productPromoId, String productPromoRuleId)
    
public  booleancontainAllWorkEffortCartItems()
    
public  booleancontainAnyWorkEffortCartItems()
    
public  booleancontainOnlyDigitalGoods()
     Check to see if the cart contains only Digital Goods, ie no Finished Goods and no Finished/Digital Goods, et cetera.
public  voidcreateDropShipGroups(LocalDispatcher dispatcher)
    
public  voiddeleteItemGroup(String groupNumber)
    
public  voidensureItemsQuantity(List cartItems, LocalDispatcher dispatcher, double quantity)
    
public  doubleensureItemsTotalQuantity(List cartItems, LocalDispatcher dispatcher, double quantity)
    
public  voidexplodeItems(List shoppingCartItems, LocalDispatcher dispatcher)
     Does an "explode", or "unitize" operation on a list of cart items.
protected  voidfinalize()
    
public  ListfindAllCartItems(String productId)
     Get all ShoppingCartItems from the cart object with the given productId.
public  ListfindAllCartItems(String productId, String groupNumber)
    
public  ListfindAllCartItemsInCategory(String productCategoryId, String groupNumber)
    
public  ShoppingCartItemfindCartItem(String productId, Map features, Map attributes, String prodCatalogId, double selectedAmount)
     Get a ShoppingCartItem from the cart object.
public  ShoppingCartItemfindCartItem(int index)
     Get a ShoppingCartItem from the cart object.
public  ShoppingCartItemfindCartItem(String orderItemSeqId)
    
public  MapgetAdditionalPartyRoleMap()
    
public  ListgetAdjustments()
    
public  StringgetAgreementId()
    
public  MapgetAllDesiredAlternateGiftByActionCopy()
    
public  ObjectgetAttribute(String name)
    
public  StringgetAutoOrderShoppingListId()
    
public  StringgetAutoSaveListId()
    
public  GenericValuegetAutoUserLogin()
    
public  StringgetBillFromVendorPartyId()
    
public  StringgetBillToCustomerPartyId()
    
public  doublegetBillingAccountAmount()
     Returns the amount to be billed to the billing account.
public  StringgetBillingAccountId()
     Returns the billing message string.
public  doublegetBillingAccountPaymentPreferenceTotal()
    
public  StringgetCarrierPartyId(int idx)
    
public  StringgetCarrierPartyId()
    
public  TimestampgetCartCreatedTime()
    
public  ListgetCartItemsInGroup(String groupNumber)
    
public  ListgetCartItemsInNoGroup()
    
public  StringgetChannelType()
    
public  StringgetContactMech(String contactMechPurposeTypeId)
    
public  doublegetCreditCardPaymentPreferenceTotal()
    
public  ListgetCreditCards()
    
public  StringgetCurrency()
     Get the current currency setting.
public  StringgetDefaultItemComment()
    
public  StringgetDefaultItemDeliveryDate()
    
public  TimestampgetDefaultShipAfterDate()
    
public  TimestampgetDefaultShipBeforeDate()
    
public  GenericDelegatorgetDelegator()
    
public  StringgetDesiredAlternateGiftByAction(GenericPK productPromoActionPK)
    
public  doublegetDisplayGrandTotal()
     Returns the total from the cart, including tax/shipping.
public  doublegetDisplayRecurringSubTotal()
    
public  doublegetDisplaySubTotal()
    
public  StringgetEndUserCustomerPartyId()
    
public  StringgetExternalId()
    
public  StringgetFacilityId()
    
public  MapgetFeatureIdQtyMap(int idx)
     Returns a Map of all features applied to products in the cart with quantities for a specific ship group.
public  StringgetFirstAttemptOrderId()
     Returns the first attempt order ID associated with this cart or null if no order has been created yet.
public  ListgetFreeShippingProductPromoActions()
    
public  doublegetGiftCardPaymentPreferenceTotal()
    
public  ListgetGiftCards()
    
public  GenericValuegetGiftCertSettingFromStore(GenericDelegator delegator)
    
public  StringgetGiftMessage(int idx)
    
public  StringgetGiftMessage()
    
public  doublegetGrandTotal()
     Returns the total from the cart, including tax/shipping.
public  booleangetHoldOrder()
    
public  StringgetInternalCode()
    
public  ListgetInternalOrderNotes()
    
public  StringgetIsGift(int idx)
    
public  StringgetIsGift()
    
public  ShoppingCart.ShoppingCartItemGroupgetItemGroupByNumber(String groupNumber)
    
public  intgetItemIndex(ShoppingCartItem item)
     Returns this item's index.
public  doublegetItemShipGroupEstimate(int idx)
    
public  doublegetItemShipGroupQty(ShoppingCartItem item, int idx)
    
public  doublegetItemShipGroupQty(int itemIndex, int idx)
    
public  doublegetItemTotal()
     Returns the item-total in the cart (not including discount/tax/shipping).
public static  ListgetItemsProducts(List cartItems)
    
public static  doublegetItemsTotalQuantity(List cartItems)
    
public  TimestampgetLastListRestore()
    
public  ListgetLineListOrderedByBasePrice(boolean ascending)
    
public  LocalegetLocale()
    
public  StringgetMaySplit(int idx)
    
public  StringgetMaySplit()
    
public  StringgetOrderAdditionalEmails()
    
public  StringgetOrderAttribute(String name)
    
public  MapgetOrderContactMechIds()
    
public  TimestampgetOrderDate()
    
public  StringgetOrderId()
     Returns the order ID associated with this cart or null if no order has been created yet.
public  StringgetOrderName()
    
public  ListgetOrderNotes()
    
public  doublegetOrderOtherAdjustmentTotal()
    
public  StringgetOrderPartyId()
    
public  doublegetOrderPaymentPreferenceTotalByType(String paymentMethodTypeId)
     Get the total payment amount by payment type.
public  doublegetOrderShipping()
    
public  ListgetOrderTerms()
    
public  StringgetOrderType()
     Returns the order type.
public  DoublegetPartyDaysSinceCreated(Timestamp nowTimestamp)
    
public  StringgetPartyId()
    
public  DoublegetPaymentAmount(String id)
    
public  CartPaymentInfogetPaymentInfo(int index)
    
public  CartPaymentInfogetPaymentInfo(String id, String refNum, String authCode, Double amount, boolean update)
    
public  CartPaymentInfogetPaymentInfo(String id, String refNum, String authCode, Double amount)
    
public  CartPaymentInfogetPaymentInfo(String id)
    
public  intgetPaymentInfoIndex(String id, String refNum)
    
public  ListgetPaymentInfos(boolean isPaymentMethod, boolean isPaymentMethodType, boolean hasRefNum)
    
public  ListgetPaymentMethodIds()
    
public  StringgetPaymentMethodTypeId(String paymentMethodId)
    
public  ListgetPaymentMethodTypeIds()
    
public  ListgetPaymentMethodTypes()
    
public  ListgetPaymentMethods()
    
public  StringgetPaymentRef(String id)
    
public  doublegetPaymentTotal()
    
public  StringgetPlacingCustomerPartyId()
    
public  StringgetPoNumber()
     Returns the po number.
public  intgetProductPromoCodeUse(String productPromoCodeId)
    
public  SetgetProductPromoCodesEntered()
    
public  intgetProductPromoUseCount(String productPromoId)
    
public  IteratorgetProductPromoUseInfoIter()
    
public  doublegetProductPromoUseTotalDiscount(String productPromoId)
    
public  StringgetProductStoreId()
    
public  StringgetQuoteId()
    
public  TimestampgetShipAfterDate(int idx)
    
public  TimestampgetShipAfterDate()
    
public  TimestampgetShipBeforeDate(int idx)
    
public  TimestampgetShipBeforeDate()
    
public  StringgetShipFromVendorPartyId()
    
public  MapgetShipGroupItems(int idx)
    
public  intgetShipGroupSize()
    
public  ListgetShipGroups()
    
public  MapgetShipGroups(ShoppingCartItem item)
    
public  MapgetShipGroups(int itemIndex)
    
public  MapgetShipGroupsBySupplier(String supplierPartyId)
    
public  CartShipInfogetShipInfo(int idx)
    
public  StringgetShipToCustomerPartyId()
    
public  GenericValuegetShipmentMethodType(int idx)
     Returns the shipment method type.
public  StringgetShipmentMethodTypeId(int idx)
    
public  StringgetShipmentMethodTypeId()
    
public  ListgetShippableItemInfo(int idx)
    
public  doublegetShippableQuantity(int idx)
     Returns the total SHIPPABLE quantity in the cart for a specific ship group.
public  ListgetShippableSizes(int idx)
     Returns a List of shippable item's size for a specific ship group.
public  doublegetShippableTotal(int idx)
     Returns the SHIPPABLE item-total in the cart for a specific ship group.
public  doublegetShippableWeight(int idx)
     Returns the total SHIPPABLE weight in the cart for a specific ship group.
public  GenericValuegetShippingAddress(int idx)
    
public  GenericValuegetShippingAddress()
    
public  StringgetShippingContactMechId(int idx)
     Returns the shipping contact mech id.
public  StringgetShippingContactMechId()
    
public  StringgetShippingInstructions(int idx)
     Returns the shipping instructions.
public  StringgetShippingInstructions()
    
public  doublegetSubTotal()
     Returns the sub-total in the cart (item-total - discount).
public  doublegetSubTotalForPromotions()
     Returns the sub-total in the cart (item-total - discount).
public  StringgetSupplierAgentPartyId()
    
public  StringgetSupplierPartyId(int idx)
     Returns the supplier for the given ship group (drop shipment).
public  StringgetTerminalId()
    
public  doublegetTotalQuantity()
     Returns the total quantity in the cart.
public  doublegetTotalSalesTax(int shipGroup)
    
public  doublegetTotalSalesTax()
     Returns the tax amount from the cart object.
public  doublegetTotalShipping()
     Returns the shipping amount from the cart object.
public  doublegetTotalWeight()
     Returns the total weight in the cart.
public  StringgetTransactionId()
    
public  GenericValuegetUserLogin()
    
public  StringgetWebSiteId()
    
public  voidhandleNewUser(LocalDispatcher dispatcher)
    
public  booleanisOrderTermSet()
    
public  booleanisPaymentMethodType(String id)
    
public  booleanisPaymentSelected(String id)
    
public  booleanisPinRequiredForGC(GenericDelegator delegator)
     Determines whether pin numbers are required for gift cards, based on ProductStoreFinActSetting.
public  booleanisPurchaseOrder()
    
public  booleanisReadOnlyCart()
    
public  booleanisSalesOrder()
    
public  booleanisValidateGCFinAccount(GenericDelegator delegator)
     Returns whether the cart should validate gift cards against FinAccount (ie, internal gift certificates).
public  Listitems()
     Returns a Collection of items in the cart object.
public  Iteratoriterator()
     Returns an iterator of cart items.
public  ListmakeAllAdjustments()
    
public  ListmakeAllOrderAttributes()
    
public  ListmakeAllOrderContactMechs()
    
public  ListmakeAllOrderItemAssociations()
    
public  ListmakeAllOrderItemAttributes()
    
public  ListmakeAllOrderItemContactMechs()
    
public  ListmakeAllOrderItemPriceInfos()
    
public  ListmakeAllOrderItemSurveyResponses()
    
public  ListmakeAllOrderPaymentInfos(LocalDispatcher dispatcher)
    
public  ListmakeAllQuoteAdjustments()
     make a list of all quote adjustments including header adjustments, line adjustments, and special adjustments (shipping and tax if applicable).
public  ListmakeAllShipGroupInfos()
    
public  MapmakeCartMap(LocalDispatcher dispatcher, boolean explodeItems)
    
public  ListmakeOrderItemGroups()
    
public  ListmakeOrderItems()
    
public  ListmakeOrderItems(boolean explodeItems, LocalDispatcher dispatcher)
    
public  CartPaymentInfomakePaymentInfo(String id, String refNum, Double amount)
    
public  ListmakeProductPromoUses()
    
public  ListmakeWorkEfforts()
    
public  voidmoveCartItem(int fromIndex, int toIndex)
     Moves a line item to a differnt index.
public  voidpositionItemToGroup(int itemIndex, double quantity, int fromIndex, int toIndex, boolean clearEmptyGroups)
    
public  voidpositionItemToGroup(ShoppingCartItem item, double quantity, int fromIndex, int toIndex, boolean clearEmptyGroups)
    
public  voidremoveAdditionalPartyRole(String partyId, String roleTypeId)
     Removes a previously associated party to the order.
public  voidremoveAdjustment(int index)
    
public  voidremoveAdjustmentByType(String orderAdjustmentTypeId)
    
public  voidremoveAllDesiredAlternateGiftByActions()
    
public  voidremoveAllFreeShippingProductPromoActions()
    
public  voidremoveCartItem(ShoppingCartItem item, LocalDispatcher dispatcher)
    
public  voidremoveCartItem(int index, LocalDispatcher dispatcher)
     Remove an item from the cart object.
public  StringremoveContactMech(String contactMechPurposeTypeId)
    
public  voidremoveEmptyCartItems()
     Remove quantity 0 ShoppingCartItems from the cart object.
public  voidremoveExtraItems(List multipleItems, LocalDispatcher dispatcher, int maxItems)
    
public  voidremoveFreeShippingProductPromoAction(GenericPK productPromoActionPK)
     Removes a free shipping ProductPromoAction by trying to find one in the list with the same primary key.
public  voidremoveOrderAttribute(String name)
    
public  voidremoveOrderTerm(int index)
    
public  voidremoveOrderTerms()
    
public synchronized  voidresetPromoRuleUse(String productPromoId, String productPromoRuleId)
    
public  intselectedPayments()
    
public  voidsetAgreementId(String agreementId)
    
public  voidsetAttribute(String name, Object value)
    
public  voidsetAutoOrderShoppingListId(String autoOrderShoppingListId)
    
public  voidsetAutoSaveListId(String id)
    
public  voidsetAutoUserLogin(GenericValue autoUserLogin, LocalDispatcher dispatcher)
    
protected  voidsetAutoUserLogin(GenericValue autoUserLogin)
    
public  voidsetBillFromVendorPartyId(String billFromVendorPartyId)
    
public  voidsetBillToCustomerPartyId(String billToCustomerPartyId)
    
public  voidsetBillingAccount(String billingAccountId, double amount)
     Sets the billing account id string.
public  voidsetCarrierPartyId(int idx, String carrierPartyId)
    
public  voidsetCarrierPartyId(String carrierPartyId)
    
public  voidsetChannelType(String channelType)
    
public  voidsetCurrency(LocalDispatcher dispatcher, String currencyUom)
     Sets the currency for the cart.
public  voidsetDefaultCheckoutOptions(LocalDispatcher dispatcher)
    
public  voidsetDefaultItemComment(String comment)
    
public  voidsetDefaultItemDeliveryDate(String date)
    
public  voidsetDefaultShipAfterDate(Timestamp defaultShipAfterDate)
    
public  voidsetDefaultShipBeforeDate(Timestamp defaultShipBeforeDate)
    
public  voidsetDesiredAlternateGiftByAction(GenericPK productPromoActionPK, String productId)
    
public  voidsetEndUserCustomerPartyId(String endUserCustomerPartyId)
    
public  voidsetExternalId(String externalId)
    
public  voidsetFacilityId(String facilityId)
    
public  voidsetFirstAttemptOrderId(String orderId)
     TODO: Sets the first attempt orderId for this cart.
public  voidsetGiftMessage(int idx, String giftMessage)
    
public  voidsetGiftMessage(String giftMessage)
    
public  voidsetHoldOrder(boolean b)
    
public  voidsetInternalCode(String internalCode)
    
public  voidsetIsGift(int idx, Boolean isGift)
    
public  voidsetIsGift(Boolean isGift)
    
public  voidsetItemShipGroupEstimate(double amount, int idx)
    
public  voidsetItemShipGroupQty(int itemIndex, double quantity, int idx)
    
public  voidsetItemShipGroupQty(ShoppingCartItem item, double quantity, int idx)
    
public  voidsetItemShipGroupQty(ShoppingCartItem item, int itemIndex, double quantity, int idx)
    
public  voidsetLastListRestore(Timestamp time)
    
public  voidsetLocale(Locale locale)
    
public  voidsetMaySplit(int idx, Boolean maySplit)
    
public  voidsetMaySplit(Boolean maySplit)
    
public  voidsetNextItemSeq(long seq)
    
public  voidsetOrderAdditionalEmails(String orderAdditionalEmails)
    
public  voidsetOrderAttribute(String name, String value)
    
public  voidsetOrderDate(Timestamp t)
    
public  voidsetOrderId(String orderId)
     Sets the orderId associated with this cart.
public  voidsetOrderName(String orderName)
    
public  voidsetOrderPartyId(String orderPartyId)
    
public  voidsetOrderTermSet(boolean orderTermSet)
    
public  voidsetOrderType(String orderType)
     Sets the order type.
public  voidsetPlacingCustomerPartyId(String placingCustomerPartyId)
    
public  voidsetPoNumber(String poNumber)
     Sets the PO Number in the cart.
public  voidsetProductStoreId(String productStoreId)
     This is somewhat of a dangerous method, changing the productStoreId changes a lot of stuff including: - some items in the cart may not be valid in any catalog in the new store - promotions need to be recalculated for the products that remain - what else? lots of settings on the ProductStore... So for now this can only be called if the cart is empty...
public  voidsetQuoteId(String quoteId)
    
public  voidsetReadOnlyCart(boolean readOnlyCart)
    
public  voidsetShipAfterDate(int idx, Timestamp shipAfterDate)
    
public  voidsetShipAfterDate(Timestamp shipAfterDate)
    
public  voidsetShipBeforeDate(int idx, Timestamp shipBeforeDate)
    
public  voidsetShipBeforeDate(Timestamp shipBeforeDate)
    
public  voidsetShipFromVendorPartyId(String shipFromVendorPartyId)
    
public  voidsetShipGroupShipDatesFromItem(ShoppingCartItem item)
     Updates the shipBefore and shipAfterDates of all ship groups that the item belongs to, re-setting ship group ship before date if item ship before date is before it and ship group ship after date if item ship after date is before it.
public  voidsetShipToCustomerPartyId(String shipToCustomerPartyId)
    
public  voidsetShipmentMethodTypeId(int idx, String shipmentMethodTypeId)
     Sets the shipment method type.
public  voidsetShipmentMethodTypeId(String shipmentMethodTypeId)
    
public  voidsetShippingContactMechId(int idx, String shippingContactMechId)
     Sets the shipping contact mech id.
public  voidsetShippingContactMechId(String shippingContactMechId)
    
public  voidsetShippingInstructions(int idx, String shippingInstructions)
     Sets the shipping instructions.
public  voidsetShippingInstructions(String shippingInstructions)
    
public  voidsetSupplierAgentPartyId(String supplierAgentPartyId)
    
public  voidsetSupplierPartyId(int idx, String supplierPartyId)
     Sets the supplier for the given ship group (drop shipment).
public  voidsetTerminalId(String terminalId)
    
public  voidsetTransactionId(String transactionId)
    
public  voidsetUserLogin(GenericValue userLogin, LocalDispatcher dispatcher)
    
protected  voidsetUserLogin(GenericValue userLogin)
    
public  voidsetViewCartOnAdd(boolean viewCartOnAdd)
     Returns true if the user wishes to view the cart everytime an item is added.
public  voidsetWebSiteId(String webSiteId)
    
public  booleanshippingApplies()
    
public  intsize()
     Returns the number of items in the cart object.
public  booleantaxApplies()
    
public  booleanviewCartOnAdd()
     Returns true if the user wishes to view the cart everytime an item is added.

Field Detail
ZERO
final public static BigDecimal ZERO(Code)



autoOrderShoppingListId
protected String autoOrderShoppingListId(Code)



autoUserLogin
protected GenericValue autoUserLogin(Code)



billFromVendorPartyId
protected String billFromVendorPartyId(Code)



billToCustomerPartyId
protected String billToCustomerPartyId(Code)



currencyUom
protected String currencyUom(Code)



endUserCustomerPartyId
protected String endUserCustomerPartyId(Code)



facilityId
protected String facilityId(Code)



holdOrder
protected boolean holdOrder(Code)



locale
protected Locale locale(Code)



module
final public static String module(Code)



nextGroupNumber
protected long nextGroupNumber(Code)



orderDate
protected Timestamp orderDate(Code)



orderPartyId
protected String orderPartyId(Code)
General partyId for the Order, all other IDs default to this one if not specified explicitly



percentage
final public static BigDecimal percentage(Code)



placingCustomerPartyId
protected String placingCustomerPartyId(Code)



productStoreId
protected String productStoreId(Code)



resource_error
final public static String resource_error(Code)



rounding
final public static int rounding(Code)



scale
final public static int scale(Code)



shipFromVendorPartyId
protected String shipFromVendorPartyId(Code)



shipToCustomerPartyId
protected String shipToCustomerPartyId(Code)



supplierAgentPartyId
protected String supplierAgentPartyId(Code)



taxCalcScale
final public static int taxCalcScale(Code)



taxFinalScale
final public static int taxFinalScale(Code)



taxRounding
final public static int taxRounding(Code)



terminalId
protected String terminalId(Code)



transactionId
protected String transactionId(Code)



userLogin
protected GenericValue userLogin(Code)



webSiteId
protected String webSiteId(Code)




Constructor Detail
ShoppingCart
protected ShoppingCart()(Code)
don't allow empty constructor



ShoppingCart
public ShoppingCart(ShoppingCart cart)(Code)
Creates a new cloned ShoppingCart Object.



ShoppingCart
public ShoppingCart(GenericDelegator delegator, String productStoreId, String webSiteId, Locale locale, String currencyUom, String billToCustomerPartyId, String billFromVendorPartyId)(Code)
Creates new empty ShoppingCart object.



ShoppingCart
public ShoppingCart(GenericDelegator delegator, String productStoreId, String webSiteId, Locale locale, String currencyUom)(Code)
Creates new empty ShoppingCart object.



ShoppingCart
public ShoppingCart(GenericDelegator delegator, String productStoreId, Locale locale, String currencyUom)(Code)
Creates a new empty ShoppingCart object.




Method Detail
addAdditionalPartyRole
public void addAdditionalPartyRole(String partyId, String roleTypeId)(Code)
Associates a party with a role to the order.
Parameters:
  partyId - identifier of the party to associate to order
Parameters:
  roleTypeId - identifier of the role used in party-order association



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



addContactMech
public void addContactMech(String contactMechPurposeTypeId, String contactMechId)(Code)
Add a contact mech to this purpose; the contactMechPurposeTypeId is required



addFreeShippingProductPromoAction
public void addFreeShippingProductPromoAction(GenericValue productPromoAction)(Code)
Adds a ProductPromoAction to be used for free shipping (must be of type free shipping, or nothing will be done).



addInternalOrderNote
public void addInternalOrderNote(String note)(Code)



addItem
public int addItem(int index, ShoppingCartItem item) throws CartItemModifyException(Code)
Add an item to the shopping cart.



addItemGroup
public String addItemGroup(String groupName, String parentGroupNumber)(Code)
Creates a new Item Group and returns the groupNumber that represents it



addItemToEnd
public int addItemToEnd(String productId, Double amount, double quantity, Double unitPrice, HashMap features, HashMap attributes, String prodCatalogId, String itemType, LocalDispatcher dispatcher, Boolean triggerExternalOps, Boolean triggerPriceRules) throws CartItemModifyException, ItemNotFoundException(Code)
Add an item to the shopping cart.



addItemToEnd
public int addItemToEnd(String productId, Double amount, double quantity, Double unitPrice, HashMap features, HashMap attributes, String prodCatalogId, String itemType, LocalDispatcher dispatcher, Boolean triggerExternalOps, Boolean triggerPriceRules, Boolean skipInventoryChecks, Boolean skipProductChecks) throws CartItemModifyException, ItemNotFoundException(Code)
Add an item to the shopping cart.



addItemToEnd
public int addItemToEnd(ShoppingCartItem item) throws CartItemModifyException(Code)
Add an item to the shopping cart.



addNonProductItem
public int addNonProductItem(String itemType, String description, String categoryId, Double price, double quantity, Map attributes, String prodCatalogId, String itemGroupNumber, LocalDispatcher dispatcher) throws CartItemModifyException(Code)
Add a non-product item to the shopping cart. the new item index
throws:
  CartItemModifyException -



addOrIncreaseItem
public int addOrIncreaseItem(String productId, Double selectedAmountDbl, double quantity, Timestamp reservStart, Double reservLengthDbl, Double reservPersonsDbl, Timestamp shipBeforeDate, Timestamp shipAfterDate, Map features, Map attributes, String prodCatalogId, ProductConfigWrapper configWrapper, String itemType, String itemGroupNumber, String parentProductId, LocalDispatcher dispatcher) throws CartItemModifyException, ItemNotFoundException(Code)
Add an item to the shopping cart, or if already there, increase the quantity. the new/increased item index
throws:
  CartItemModifyException -



addOrderNote
public void addOrderNote(String note)(Code)



addOrderTerm
public int addOrderTerm(String termTypeId, Double termValue, Long termDays)(Code)
Add an orderTerm to the order



addOrderTerm
public int addOrderTerm(String termTypeId, Double termValue, Long termDays, String description)(Code)
Add an orderTerm to the order



addOrderTerm
public int addOrderTerm(GenericValue orderTerm)(Code)
Add an orderTerm to the order



addPayment
public CartPaymentInfo addPayment(String id)(Code)
adds a payment method/payment method type



addPaymentAmount
public CartPaymentInfo addPaymentAmount(String id, Double amount, String refNum, String authCode, boolean isSingleUse, boolean isPresent, boolean replace)(Code)
adds a payment method/payment method type



addPaymentAmount
public CartPaymentInfo addPaymentAmount(String id, Double amount, boolean isSingleUse)(Code)
adds a payment method/payment method type



addPaymentAmount
public CartPaymentInfo addPaymentAmount(String id, double amount, boolean isSingleUse)(Code)
adds a payment method/payment method type



addPaymentAmount
public CartPaymentInfo addPaymentAmount(String id, Double amount)(Code)
adds a payment method/payment method type



addPaymentAmount
public CartPaymentInfo addPaymentAmount(String id, double amount)(Code)
adds a payment method/payment method type



addPaymentRef
public void addPaymentRef(String id, String ref, String authCode)(Code)



addProductPromoCode
public String addProductPromoCode(String productPromoCodeId, LocalDispatcher dispatcher)(Code)
Adds a promotion code to the cart, checking if it is valid. If it is valid this will return null, otherwise it will return a message stating why it was not valid
Parameters:
  productPromoCodeId - The promotion code to check and add String that is null if valid, and added to cart, or an error message of the code was not valid and not added to the cart.



addProductPromoUse
public void addProductPromoUse(String productPromoId, String productPromoCodeId, double totalDiscountAmount, double quantityLeftInActions)(Code)



addShipInfo
public int addShipInfo()(Code)



checkShipItemInfo
protected boolean checkShipItemInfo(CartShipInfo csi, CartShipInfo.CartShipItemInfo csii)(Code)



cleanUpShipGroups
protected void cleanUpShipGroups()(Code)



clear
public void clear()(Code)
Clears out the cart.



clearAllAdjustments
public void clearAllAdjustments()(Code)



clearAllItemStatus
public void clearAllItemStatus()(Code)



clearAllPromotionAdjustments
public void clearAllPromotionAdjustments()(Code)



clearAllPromotionInformation
public void clearAllPromotionInformation()(Code)



clearCartItemUseInPromoInfo
public void clearCartItemUseInPromoInfo()(Code)



clearDeclinedPaymentMethodsFromOrder
public void clearDeclinedPaymentMethodsFromOrder(GenericDelegator delegator, String orderId)(Code)
remove declined payment methods for an order from cart. The idea is to call this after an attempted order is rejected



clearItemShipInfo
public void clearItemShipInfo(ShoppingCartItem item)(Code)



clearPayment
public void clearPayment(String id)(Code)
removes a specific payment method/payment method type



clearPayment
public void clearPayment(int index)(Code)
removes a specific payment info from the list



clearPaymentMethodsById
public void clearPaymentMethodsById(List paymentMethodIdsToRemove)(Code)
remove all the paymentMethods based on the paymentMethodIds



clearPayments
public void clearPayments()(Code)
clears all payment method/payment method types



clearProductPromoUseInfo
public void clearProductPromoUseInfo()(Code)



confirmPromoRuleUse
public synchronized void confirmPromoRuleUse(String productPromoId, String productPromoRuleId)(Code)



containAllWorkEffortCartItems
public boolean containAllWorkEffortCartItems()(Code)



containAnyWorkEffortCartItems
public boolean containAnyWorkEffortCartItems()(Code)



containOnlyDigitalGoods
public boolean containOnlyDigitalGoods()(Code)
Check to see if the cart contains only Digital Goods, ie no Finished Goods and no Finished/Digital Goods, et cetera. This is determined by making sure no Product has a type where ProductType.isPhysical!=N.



createDropShipGroups
public void createDropShipGroups(LocalDispatcher dispatcher) throws CartItemModifyException(Code)
Examine each item of each ship group and create new ship groups if the item should be drop shipped
Parameters:
  dispatcher -
throws:
  CartItemModifyException -



deleteItemGroup
public void deleteItemGroup(String groupNumber)(Code)



ensureItemsQuantity
public void ensureItemsQuantity(List cartItems, LocalDispatcher dispatcher, double quantity) throws CartItemModifyException(Code)



ensureItemsTotalQuantity
public double ensureItemsTotalQuantity(List cartItems, LocalDispatcher dispatcher, double quantity) throws CartItemModifyException(Code)



explodeItems
public void explodeItems(List shoppingCartItems, LocalDispatcher dispatcher)(Code)
Does an "explode", or "unitize" operation on a list of cart items. Resulting state for each item with quantity X is X items of quantity 1.
Parameters:
  shoppingCartItems -
Parameters:
  dispatcher -



finalize
protected void finalize() throws Throwable(Code)



findAllCartItems
public List findAllCartItems(String productId)(Code)
Get all ShoppingCartItems from the cart object with the given productId.



findAllCartItems
public List findAllCartItems(String productId, String groupNumber)(Code)
Get all ShoppingCartItems from the cart object with the given productId and optional groupNumber to limit it to a specific item group



findAllCartItemsInCategory
public List findAllCartItemsInCategory(String productCategoryId, String groupNumber)(Code)
Get all ShoppingCartItems from the cart object with the given productCategoryId and optional groupNumber to limit it to a specific item group



findCartItem
public ShoppingCartItem findCartItem(String productId, Map features, Map attributes, String prodCatalogId, double selectedAmount)(Code)
Get a ShoppingCartItem from the cart object.



findCartItem
public ShoppingCartItem findCartItem(int index)(Code)
Get a ShoppingCartItem from the cart object.



findCartItem
public ShoppingCartItem findCartItem(String orderItemSeqId)(Code)



getAdditionalPartyRoleMap
public Map getAdditionalPartyRoleMap()(Code)



getAdjustments
public List getAdjustments()(Code)
Get a List of adjustments on the order (ie cart)



getAgreementId
public String getAgreementId()(Code)



getAllDesiredAlternateGiftByActionCopy
public Map getAllDesiredAlternateGiftByActionCopy()(Code)



getAttribute
public Object getAttribute(String name)(Code)



getAutoOrderShoppingListId
public String getAutoOrderShoppingListId()(Code)



getAutoSaveListId
public String getAutoSaveListId()(Code)



getAutoUserLogin
public GenericValue getAutoUserLogin()(Code)



getBillFromVendorPartyId
public String getBillFromVendorPartyId()(Code)



getBillToCustomerPartyId
public String getBillToCustomerPartyId()(Code)



getBillingAccountAmount
public double getBillingAccountAmount()(Code)
Returns the amount to be billed to the billing account.



getBillingAccountId
public String getBillingAccountId()(Code)
Returns the billing message string.



getBillingAccountPaymentPreferenceTotal
public double getBillingAccountPaymentPreferenceTotal()(Code)



getCarrierPartyId
public String getCarrierPartyId(int idx)(Code)



getCarrierPartyId
public String getCarrierPartyId()(Code)



getCartCreatedTime
public Timestamp getCartCreatedTime()(Code)



getCartItemsInGroup
public List getCartItemsInGroup(String groupNumber)(Code)



getCartItemsInNoGroup
public List getCartItemsInNoGroup()(Code)



getChannelType
public String getChannelType()(Code)



getContactMech
public String getContactMech(String contactMechPurposeTypeId)(Code)
Get the contactMechId for this cart given the contactMechPurposeTypeId



getCreditCardPaymentPreferenceTotal
public double getCreditCardPaymentPreferenceTotal()(Code)



getCreditCards
public List getCreditCards()(Code)



getCurrency
public String getCurrency()(Code)
Get the current currency setting.



getDefaultItemComment
public String getDefaultItemComment()(Code)



getDefaultItemDeliveryDate
public String getDefaultItemDeliveryDate()(Code)



getDefaultShipAfterDate
public Timestamp getDefaultShipAfterDate()(Code)



getDefaultShipBeforeDate
public Timestamp getDefaultShipBeforeDate()(Code)



getDelegator
public GenericDelegator getDelegator()(Code)



getDesiredAlternateGiftByAction
public String getDesiredAlternateGiftByAction(GenericPK productPromoActionPK)(Code)



getDisplayGrandTotal
public double getDisplayGrandTotal()(Code)
Returns the total from the cart, including tax/shipping.



getDisplayRecurringSubTotal
public double getDisplayRecurringSubTotal()(Code)



getDisplaySubTotal
public double getDisplaySubTotal()(Code)



getEndUserCustomerPartyId
public String getEndUserCustomerPartyId()(Code)



getExternalId
public String getExternalId()(Code)



getFacilityId
public String getFacilityId()(Code)



getFeatureIdQtyMap
public Map getFeatureIdQtyMap(int idx)(Code)
Returns a Map of all features applied to products in the cart with quantities for a specific ship group.



getFirstAttemptOrderId
public String getFirstAttemptOrderId()(Code)
Returns the first attempt order ID associated with this cart or null if no order has been created yet.



getFreeShippingProductPromoActions
public List getFreeShippingProductPromoActions()(Code)



getGiftCardPaymentPreferenceTotal
public double getGiftCardPaymentPreferenceTotal()(Code)



getGiftCards
public List getGiftCards()(Code)



getGiftCertSettingFromStore
public GenericValue getGiftCertSettingFromStore(GenericDelegator delegator) throws GenericEntityException(Code)
Returns ProductStoreFinActSetting based on cart's productStoreId and FinAccountHelper's defined giftCertFinAcctTypeId
Parameters:
  delegator -
throws:
  GenericEntityException -



getGiftMessage
public String getGiftMessage(int idx)(Code)



getGiftMessage
public String getGiftMessage()(Code)



getGrandTotal
public double getGrandTotal()(Code)
Returns the total from the cart, including tax/shipping.



getHoldOrder
public boolean getHoldOrder()(Code)



getInternalCode
public String getInternalCode()(Code)



getInternalOrderNotes
public List getInternalOrderNotes()(Code)



getIsGift
public String getIsGift(int idx)(Code)



getIsGift
public String getIsGift()(Code)



getItemGroupByNumber
public ShoppingCart.ShoppingCartItemGroup getItemGroupByNumber(String groupNumber)(Code)



getItemIndex
public int getItemIndex(ShoppingCartItem item)(Code)
Returns this item's index.



getItemShipGroupEstimate
public double getItemShipGroupEstimate(int idx)(Code)



getItemShipGroupQty
public double getItemShipGroupQty(ShoppingCartItem item, int idx)(Code)



getItemShipGroupQty
public double getItemShipGroupQty(int itemIndex, int idx)(Code)



getItemTotal
public double getItemTotal()(Code)
Returns the item-total in the cart (not including discount/tax/shipping).



getItemsProducts
public static List getItemsProducts(List cartItems)(Code)



getItemsTotalQuantity
public static double getItemsTotalQuantity(List cartItems)(Code)



getLastListRestore
public Timestamp getLastListRestore()(Code)



getLineListOrderedByBasePrice
public List getLineListOrderedByBasePrice(boolean ascending)(Code)



getLocale
public Locale getLocale()(Code)



getMaySplit
public String getMaySplit(int idx)(Code)
Returns Boolean.TRUE if the order may be split (null if unspecified)



getMaySplit
public String getMaySplit()(Code)



getOrderAdditionalEmails
public String getOrderAdditionalEmails()(Code)



getOrderAttribute
public String getOrderAttribute(String name)(Code)



getOrderContactMechIds
public Map getOrderContactMechIds()(Code)



getOrderDate
public Timestamp getOrderDate()(Code)



getOrderId
public String getOrderId()(Code)
Returns the order ID associated with this cart or null if no order has been created yet.



getOrderName
public String getOrderName()(Code)



getOrderNotes
public List getOrderNotes()(Code)



getOrderOtherAdjustmentTotal
public double getOrderOtherAdjustmentTotal()(Code)



getOrderPartyId
public String getOrderPartyId()(Code)



getOrderPaymentPreferenceTotalByType
public double getOrderPaymentPreferenceTotalByType(String paymentMethodTypeId)(Code)
Get the total payment amount by payment type. Specify null to get amount over all types.



getOrderShipping
public double getOrderShipping()(Code)
Returns the order level shipping amount



getOrderTerms
public List getOrderTerms()(Code)
Get a List of orderTerms on the order (ie cart)



getOrderType
public String getOrderType()(Code)
Returns the order type.



getPartyDaysSinceCreated
public Double getPartyDaysSinceCreated(Timestamp nowTimestamp)(Code)



getPartyId
public String getPartyId()(Code)



getPaymentAmount
public Double getPaymentAmount(String id)(Code)
returns the payment method/payment method type amount



getPaymentInfo
public CartPaymentInfo getPaymentInfo(int index)(Code)
Locates an existing CartPaymentInfo object by index



getPaymentInfo
public CartPaymentInfo getPaymentInfo(String id, String refNum, String authCode, Double amount, boolean update)(Code)
Locates an existing (or creates a new) CartPaymentInfo object



getPaymentInfo
public CartPaymentInfo getPaymentInfo(String id, String refNum, String authCode, Double amount)(Code)
Locates an existing (or creates a new) CartPaymentInfo object



getPaymentInfo
public CartPaymentInfo getPaymentInfo(String id)(Code)
Locates an existing (or creates a new) CartPaymentInfo object



getPaymentInfoIndex
public int getPaymentInfoIndex(String id, String refNum)(Code)
Locates the index of an existing CartPaymentInfo object or -1 if none found



getPaymentInfos
public List getPaymentInfos(boolean isPaymentMethod, boolean isPaymentMethodType, boolean hasRefNum)(Code)
Returns the CartPaymentInfo objects which have matching fields



getPaymentMethodIds
public List getPaymentMethodIds()(Code)
Returns the Payment Method Ids



getPaymentMethodTypeId
public String getPaymentMethodTypeId(String paymentMethodId)(Code)



getPaymentMethodTypeIds
public List getPaymentMethodTypeIds()(Code)
Returns the Payment Method Ids



getPaymentMethodTypes
public List getPaymentMethodTypes()(Code)
Returns a list of PaymentMethodType value objects selected in the cart



getPaymentMethods
public List getPaymentMethods()(Code)
Returns a list of PaymentMethod value objects selected in the cart



getPaymentRef
public String getPaymentRef(String id)(Code)



getPaymentTotal
public double getPaymentTotal()(Code)
returns the total payment amounts



getPlacingCustomerPartyId
public String getPlacingCustomerPartyId()(Code)



getPoNumber
public String getPoNumber()(Code)
Returns the po number.



getProductPromoCodeUse
public int getProductPromoCodeUse(String productPromoCodeId)(Code)



getProductPromoCodesEntered
public Set getProductPromoCodesEntered()(Code)



getProductPromoUseCount
public int getProductPromoUseCount(String productPromoId)(Code)



getProductPromoUseInfoIter
public Iterator getProductPromoUseInfoIter()(Code)



getProductPromoUseTotalDiscount
public double getProductPromoUseTotalDiscount(String productPromoId)(Code)



getProductStoreId
public String getProductStoreId()(Code)



getQuoteId
public String getQuoteId()(Code)



getShipAfterDate
public Timestamp getShipAfterDate(int idx)(Code)
Get ship after date for a particular ship group
Parameters:
  idx -



getShipAfterDate
public Timestamp getShipAfterDate()(Code)
Get ship after date for ship group 0



getShipBeforeDate
public Timestamp getShipBeforeDate(int idx)(Code)
Get ship before date for a particular ship group
Parameters:
  idx -



getShipBeforeDate
public Timestamp getShipBeforeDate()(Code)
Get ship before date for ship group 0



getShipFromVendorPartyId
public String getShipFromVendorPartyId()(Code)



getShipGroupItems
public Map getShipGroupItems(int idx)(Code)
Returns the ShoppingCartItem (key) and quantity (value) associated with the ship group



getShipGroupSize
public int getShipGroupSize()(Code)



getShipGroups
public List getShipGroups()(Code)



getShipGroups
public Map getShipGroups(ShoppingCartItem item)(Code)



getShipGroups
public Map getShipGroups(int itemIndex)(Code)



getShipGroupsBySupplier
public Map getShipGroupsBySupplier(String supplierPartyId)(Code)



getShipInfo
public CartShipInfo getShipInfo(int idx)(Code)



getShipToCustomerPartyId
public String getShipToCustomerPartyId()(Code)



getShipmentMethodType
public GenericValue getShipmentMethodType(int idx)(Code)
Returns the shipment method type.



getShipmentMethodTypeId
public String getShipmentMethodTypeId(int idx)(Code)
Returns the shipment method type ID



getShipmentMethodTypeId
public String getShipmentMethodTypeId()(Code)



getShippableItemInfo
public List getShippableItemInfo(int idx)(Code)
Returns a List of shippable item info (quantity, size, weight) for a specific ship group



getShippableQuantity
public double getShippableQuantity(int idx)(Code)
Returns the total SHIPPABLE quantity in the cart for a specific ship group.



getShippableSizes
public List getShippableSizes(int idx)(Code)
Returns a List of shippable item's size for a specific ship group.



getShippableTotal
public double getShippableTotal(int idx)(Code)
Returns the SHIPPABLE item-total in the cart for a specific ship group.



getShippableWeight
public double getShippableWeight(int idx)(Code)
Returns the total SHIPPABLE weight in the cart for a specific ship group.



getShippingAddress
public GenericValue getShippingAddress(int idx)(Code)



getShippingAddress
public GenericValue getShippingAddress()(Code)



getShippingContactMechId
public String getShippingContactMechId(int idx)(Code)
Returns the shipping contact mech id.



getShippingContactMechId
public String getShippingContactMechId()(Code)



getShippingInstructions
public String getShippingInstructions(int idx)(Code)
Returns the shipping instructions.



getShippingInstructions
public String getShippingInstructions()(Code)



getSubTotal
public double getSubTotal()(Code)
Returns the sub-total in the cart (item-total - discount).



getSubTotalForPromotions
public double getSubTotalForPromotions()(Code)
Returns the sub-total in the cart (item-total - discount).



getSupplierAgentPartyId
public String getSupplierAgentPartyId()(Code)



getSupplierPartyId
public String getSupplierPartyId(int idx)(Code)
Returns the supplier for the given ship group (drop shipment).



getTerminalId
public String getTerminalId()(Code)



getTotalQuantity
public double getTotalQuantity()(Code)
Returns the total quantity in the cart.



getTotalSalesTax
public double getTotalSalesTax(int shipGroup)(Code)



getTotalSalesTax
public double getTotalSalesTax()(Code)
Returns the tax amount from the cart object.



getTotalShipping
public double getTotalShipping()(Code)
Returns the shipping amount from the cart object.



getTotalWeight
public double getTotalWeight()(Code)
Returns the total weight in the cart.



getTransactionId
public String getTransactionId()(Code)



getUserLogin
public GenericValue getUserLogin()(Code)
Gets the userLogin associated with the cart; may be null



getWebSiteId
public String getWebSiteId()(Code)



handleNewUser
public void handleNewUser(LocalDispatcher dispatcher) throws CartItemModifyException(Code)



isOrderTermSet
public boolean isOrderTermSet()(Code)



isPaymentMethodType
public boolean isPaymentMethodType(String id)(Code)



isPaymentSelected
public boolean isPaymentSelected(String id)(Code)



isPinRequiredForGC
public boolean isPinRequiredForGC(GenericDelegator delegator)(Code)
Determines whether pin numbers are required for gift cards, based on ProductStoreFinActSetting. Default to true.



isPurchaseOrder
public boolean isPurchaseOrder()(Code)



isReadOnlyCart
public boolean isReadOnlyCart()(Code)



isSalesOrder
public boolean isSalesOrder()(Code)



isValidateGCFinAccount
public boolean isValidateGCFinAccount(GenericDelegator delegator)(Code)
Returns whether the cart should validate gift cards against FinAccount (ie, internal gift certificates). Defaults to false.
Parameters:
  delegator -



items
public List items()(Code)
Returns a Collection of items in the cart object.



iterator
public Iterator iterator()(Code)
Returns an iterator of cart items.



makeAllAdjustments
public List makeAllAdjustments()(Code)
make a list of all adjustments including order adjustments, order line adjustments, and special adjustments (shipping and tax if applicable)



makeAllOrderAttributes
public List makeAllOrderAttributes()(Code)



makeAllOrderContactMechs
public List makeAllOrderContactMechs()(Code)
make a list of OrderContactMechs from the ShoppingCart and the ShoppingCartItems



makeAllOrderItemAssociations
public List makeAllOrderItemAssociations()(Code)



makeAllOrderItemAttributes
public List makeAllOrderItemAttributes()(Code)



makeAllOrderItemContactMechs
public List makeAllOrderItemContactMechs()(Code)
make a list of OrderContactMechs from the ShoppingCart and the ShoppingCartItems



makeAllOrderItemPriceInfos
public List makeAllOrderItemPriceInfos()(Code)
make a list of OrderItemPriceInfos from the ShoppingCartItems



makeAllOrderItemSurveyResponses
public List makeAllOrderItemSurveyResponses()(Code)
make a list of SurveyResponse object to update with order information set



makeAllOrderPaymentInfos
public List makeAllOrderPaymentInfos(LocalDispatcher dispatcher)(Code)
make a list of all OrderPaymentPreferences and Billing info including all payment methods and types



makeAllQuoteAdjustments
public List makeAllQuoteAdjustments()(Code)
make a list of all quote adjustments including header adjustments, line adjustments, and special adjustments (shipping and tax if applicable). Internally, the quote adjustments are created from the order adjustments.



makeAllShipGroupInfos
public List makeAllShipGroupInfos()(Code)



makeCartMap
public Map makeCartMap(LocalDispatcher dispatcher, boolean explodeItems)(Code)
Returns a Map of cart values to pass to the storeOrder service



makeOrderItemGroups
public List makeOrderItemGroups()(Code)



makeOrderItems
public List makeOrderItems()(Code)



makeOrderItems
public List makeOrderItems(boolean explodeItems, LocalDispatcher dispatcher)(Code)



makePaymentInfo
public CartPaymentInfo makePaymentInfo(String id, String refNum, Double amount)(Code)
Creates a CartPaymentInfo object



makeProductPromoUses
public List makeProductPromoUses()(Code)



makeWorkEfforts
public List makeWorkEfforts()(Code)
create WorkEfforts from the shoppingcart items when itemType = RENTAL_ORDER_ITEM



moveCartItem
public void moveCartItem(int fromIndex, int toIndex)(Code)
Moves a line item to a differnt index.



positionItemToGroup
public void positionItemToGroup(int itemIndex, double quantity, int fromIndex, int toIndex, boolean clearEmptyGroups)(Code)



positionItemToGroup
public void positionItemToGroup(ShoppingCartItem item, double quantity, int fromIndex, int toIndex, boolean clearEmptyGroups)(Code)



removeAdditionalPartyRole
public void removeAdditionalPartyRole(String partyId, String roleTypeId)(Code)
Removes a previously associated party to the order.
Parameters:
  partyId - identifier of the party to associate to order
Parameters:
  roleTypeId - identifier of the role used in party-order association



removeAdjustment
public void removeAdjustment(int index)(Code)



removeAdjustmentByType
public void removeAdjustmentByType(String orderAdjustmentTypeId)(Code)
go through the order adjustments and remove all adjustments with the given type



removeAllDesiredAlternateGiftByActions
public void removeAllDesiredAlternateGiftByActions()(Code)



removeAllFreeShippingProductPromoActions
public void removeAllFreeShippingProductPromoActions()(Code)



removeCartItem
public void removeCartItem(ShoppingCartItem item, LocalDispatcher dispatcher) throws CartItemModifyException(Code)



removeCartItem
public void removeCartItem(int index, LocalDispatcher dispatcher) throws CartItemModifyException(Code)
Remove an item from the cart object.



removeContactMech
public String removeContactMech(String contactMechPurposeTypeId)(Code)
Remove the contactMechId from this cart given the contactMechPurposeTypeId



removeEmptyCartItems
public void removeEmptyCartItems()(Code)
Remove quantity 0 ShoppingCartItems from the cart object.



removeExtraItems
public void removeExtraItems(List multipleItems, LocalDispatcher dispatcher, int maxItems) throws CartItemModifyException(Code)



removeFreeShippingProductPromoAction
public void removeFreeShippingProductPromoAction(GenericPK productPromoActionPK)(Code)
Removes a free shipping ProductPromoAction by trying to find one in the list with the same primary key.



removeOrderAttribute
public void removeOrderAttribute(String name)(Code)



removeOrderTerm
public void removeOrderTerm(int index)(Code)



removeOrderTerms
public void removeOrderTerms()(Code)



resetPromoRuleUse
public synchronized void resetPromoRuleUse(String productPromoId, String productPromoRuleId)(Code)



selectedPayments
public int selectedPayments()(Code)



setAgreementId
public void setAgreementId(String agreementId)(Code)



setAttribute
public void setAttribute(String name, Object value)(Code)



setAutoOrderShoppingListId
public void setAutoOrderShoppingListId(String autoOrderShoppingListId)(Code)



setAutoSaveListId
public void setAutoSaveListId(String id)(Code)



setAutoUserLogin
public void setAutoUserLogin(GenericValue autoUserLogin, LocalDispatcher dispatcher) throws CartItemModifyException(Code)



setAutoUserLogin
protected void setAutoUserLogin(GenericValue autoUserLogin)(Code)



setBillFromVendorPartyId
public void setBillFromVendorPartyId(String billFromVendorPartyId)(Code)



setBillToCustomerPartyId
public void setBillToCustomerPartyId(String billToCustomerPartyId)(Code)



setBillingAccount
public void setBillingAccount(String billingAccountId, double amount)(Code)
Sets the billing account id string.



setCarrierPartyId
public void setCarrierPartyId(int idx, String carrierPartyId)(Code)



setCarrierPartyId
public void setCarrierPartyId(String carrierPartyId)(Code)



setChannelType
public void setChannelType(String channelType)(Code)



setCurrency
public void setCurrency(LocalDispatcher dispatcher, String currencyUom) throws CartItemModifyException(Code)
Sets the currency for the cart.



setDefaultCheckoutOptions
public void setDefaultCheckoutOptions(LocalDispatcher dispatcher)(Code)



setDefaultItemComment
public void setDefaultItemComment(String comment)(Code)



setDefaultItemDeliveryDate
public void setDefaultItemDeliveryDate(String date)(Code)



setDefaultShipAfterDate
public void setDefaultShipAfterDate(Timestamp defaultShipAfterDate)(Code)



setDefaultShipBeforeDate
public void setDefaultShipBeforeDate(Timestamp defaultShipBeforeDate)(Code)



setDesiredAlternateGiftByAction
public void setDesiredAlternateGiftByAction(GenericPK productPromoActionPK, String productId)(Code)



setEndUserCustomerPartyId
public void setEndUserCustomerPartyId(String endUserCustomerPartyId)(Code)



setExternalId
public void setExternalId(String externalId)(Code)



setFacilityId
public void setFacilityId(String facilityId)(Code)



setFirstAttemptOrderId
public void setFirstAttemptOrderId(String orderId)(Code)
TODO: Sets the first attempt orderId for this cart.



setGiftMessage
public void setGiftMessage(int idx, String giftMessage)(Code)



setGiftMessage
public void setGiftMessage(String giftMessage)(Code)



setHoldOrder
public void setHoldOrder(boolean b)(Code)



setInternalCode
public void setInternalCode(String internalCode)(Code)



setIsGift
public void setIsGift(int idx, Boolean isGift)(Code)



setIsGift
public void setIsGift(Boolean isGift)(Code)



setItemShipGroupEstimate
public void setItemShipGroupEstimate(double amount, int idx)(Code)



setItemShipGroupQty
public void setItemShipGroupQty(int itemIndex, double quantity, int idx)(Code)



setItemShipGroupQty
public void setItemShipGroupQty(ShoppingCartItem item, double quantity, int idx)(Code)



setItemShipGroupQty
public void setItemShipGroupQty(ShoppingCartItem item, int itemIndex, double quantity, int idx)(Code)



setLastListRestore
public void setLastListRestore(Timestamp time)(Code)



setLocale
public void setLocale(Locale locale)(Code)



setMaySplit
public void setMaySplit(int idx, Boolean maySplit)(Code)



setMaySplit
public void setMaySplit(Boolean maySplit)(Code)



setNextItemSeq
public void setNextItemSeq(long seq) throws GeneralException(Code)



setOrderAdditionalEmails
public void setOrderAdditionalEmails(String orderAdditionalEmails)(Code)



setOrderAttribute
public void setOrderAttribute(String name, String value)(Code)



setOrderDate
public void setOrderDate(Timestamp t)(Code)



setOrderId
public void setOrderId(String orderId)(Code)
Sets the orderId associated with this cart.



setOrderName
public void setOrderName(String orderName)(Code)



setOrderPartyId
public void setOrderPartyId(String orderPartyId)(Code)



setOrderTermSet
public void setOrderTermSet(boolean orderTermSet)(Code)



setOrderType
public void setOrderType(String orderType)(Code)
Sets the order type.



setPlacingCustomerPartyId
public void setPlacingCustomerPartyId(String placingCustomerPartyId)(Code)



setPoNumber
public void setPoNumber(String poNumber)(Code)
Sets the PO Number in the cart.



setProductStoreId
public void setProductStoreId(String productStoreId)(Code)
This is somewhat of a dangerous method, changing the productStoreId changes a lot of stuff including: - some items in the cart may not be valid in any catalog in the new store - promotions need to be recalculated for the products that remain - what else? lots of settings on the ProductStore... So for now this can only be called if the cart is empty... otherwise it wil throw an exception



setQuoteId
public void setQuoteId(String quoteId)(Code)



setReadOnlyCart
public void setReadOnlyCart(boolean readOnlyCart)(Code)



setShipAfterDate
public void setShipAfterDate(int idx, Timestamp shipAfterDate)(Code)
Set ship after date for a particular ship group
Parameters:
  idx -
Parameters:
  shipAfterDate -



setShipAfterDate
public void setShipAfterDate(Timestamp shipAfterDate)(Code)
Set ship after date for a particular ship group
Parameters:
  shipAfterDate -



setShipBeforeDate
public void setShipBeforeDate(int idx, Timestamp shipBeforeDate)(Code)
Set ship before date for a particular ship group
Parameters:
  idx -
Parameters:
  shipBeforeDate -



setShipBeforeDate
public void setShipBeforeDate(Timestamp shipBeforeDate)(Code)
Set ship before date for ship group 0
Parameters:
  shipBeforeDate -



setShipFromVendorPartyId
public void setShipFromVendorPartyId(String shipFromVendorPartyId)(Code)



setShipGroupShipDatesFromItem
public void setShipGroupShipDatesFromItem(ShoppingCartItem item)(Code)
Updates the shipBefore and shipAfterDates of all ship groups that the item belongs to, re-setting ship group ship before date if item ship before date is before it and ship group ship after date if item ship after date is before it.
Parameters:
  item -



setShipToCustomerPartyId
public void setShipToCustomerPartyId(String shipToCustomerPartyId)(Code)



setShipmentMethodTypeId
public void setShipmentMethodTypeId(int idx, String shipmentMethodTypeId)(Code)
Sets the shipment method type.



setShipmentMethodTypeId
public void setShipmentMethodTypeId(String shipmentMethodTypeId)(Code)



setShippingContactMechId
public void setShippingContactMechId(int idx, String shippingContactMechId)(Code)
Sets the shipping contact mech id.



setShippingContactMechId
public void setShippingContactMechId(String shippingContactMechId)(Code)



setShippingInstructions
public void setShippingInstructions(int idx, String shippingInstructions)(Code)
Sets the shipping instructions.



setShippingInstructions
public void setShippingInstructions(String shippingInstructions)(Code)



setSupplierAgentPartyId
public void setSupplierAgentPartyId(String supplierAgentPartyId)(Code)



setSupplierPartyId
public void setSupplierPartyId(int idx, String supplierPartyId)(Code)
Sets the supplier for the given ship group (drop shipment).



setTerminalId
public void setTerminalId(String terminalId)(Code)



setTransactionId
public void setTransactionId(String transactionId)(Code)



setUserLogin
public void setUserLogin(GenericValue userLogin, LocalDispatcher dispatcher) throws CartItemModifyException(Code)



setUserLogin
protected void setUserLogin(GenericValue userLogin)(Code)



setViewCartOnAdd
public void setViewCartOnAdd(boolean viewCartOnAdd)(Code)
Returns true if the user wishes to view the cart everytime an item is added.



setWebSiteId
public void setWebSiteId(String webSiteId)(Code)



shippingApplies
public boolean shippingApplies()(Code)
Returns true when there are shippable items in the cart



size
public int size()(Code)
Returns the number of items in the cart object.



taxApplies
public boolean taxApplies()(Code)
Returns true when there are taxable items in the cart



viewCartOnAdd
public boolean viewCartOnAdd()(Code)
Returns true if the user wishes to view the cart everytime an item is added.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.