001 /** 002 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.shopping.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * The utility for the shopping cart local service. This utility wraps {@link com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 022 * 023 * <p> 024 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see ShoppingCartLocalService 029 * @see com.liferay.portlet.shopping.service.base.ShoppingCartLocalServiceBaseImpl 030 * @see com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl 031 * @generated 032 */ 033 public class ShoppingCartLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 038 */ 039 040 /** 041 * Adds the shopping cart to the database. Also notifies the appropriate model listeners. 042 * 043 * @param shoppingCart the shopping cart 044 * @return the shopping cart that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portlet.shopping.model.ShoppingCart addShoppingCart( 048 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addShoppingCart(shoppingCart); 051 } 052 053 /** 054 * Creates a new shopping cart with the primary key. Does not add the shopping cart to the database. 055 * 056 * @param cartId the primary key for the new shopping cart 057 * @return the new shopping cart 058 */ 059 public static com.liferay.portlet.shopping.model.ShoppingCart createShoppingCart( 060 long cartId) { 061 return getService().createShoppingCart(cartId); 062 } 063 064 /** 065 * Deletes the shopping cart with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param cartId the primary key of the shopping cart 068 * @return the shopping cart that was removed 069 * @throws PortalException if a shopping cart with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart( 073 long cartId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deleteShoppingCart(cartId); 077 } 078 079 /** 080 * Deletes the shopping cart from the database. Also notifies the appropriate model listeners. 081 * 082 * @param shoppingCart the shopping cart 083 * @return the shopping cart that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public static com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart( 087 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deleteShoppingCart(shoppingCart); 090 } 091 092 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 093 return getService().dynamicQuery(); 094 } 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public static java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException { 107 return getService().dynamicQuery(dynamicQuery); 108 } 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public static java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return getService().dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public static java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException { 150 return getService() 151 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 152 } 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public static long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().dynamicQueryCount(dynamicQuery); 165 } 166 167 public static com.liferay.portlet.shopping.model.ShoppingCart fetchShoppingCart( 168 long cartId) throws com.liferay.portal.kernel.exception.SystemException { 169 return getService().fetchShoppingCart(cartId); 170 } 171 172 /** 173 * Returns the shopping cart with the primary key. 174 * 175 * @param cartId the primary key of the shopping cart 176 * @return the shopping cart 177 * @throws PortalException if a shopping cart with the primary key could not be found 178 * @throws SystemException if a system exception occurred 179 */ 180 public static com.liferay.portlet.shopping.model.ShoppingCart getShoppingCart( 181 long cartId) 182 throws com.liferay.portal.kernel.exception.PortalException, 183 com.liferay.portal.kernel.exception.SystemException { 184 return getService().getShoppingCart(cartId); 185 } 186 187 public static com.liferay.portal.model.PersistedModel getPersistedModel( 188 java.io.Serializable primaryKeyObj) 189 throws com.liferay.portal.kernel.exception.PortalException, 190 com.liferay.portal.kernel.exception.SystemException { 191 return getService().getPersistedModel(primaryKeyObj); 192 } 193 194 /** 195 * Returns a range of all the shopping carts. 196 * 197 * <p> 198 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 199 * </p> 200 * 201 * @param start the lower bound of the range of shopping carts 202 * @param end the upper bound of the range of shopping carts (not inclusive) 203 * @return the range of shopping carts 204 * @throws SystemException if a system exception occurred 205 */ 206 public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCart> getShoppingCarts( 207 int start, int end) 208 throws com.liferay.portal.kernel.exception.SystemException { 209 return getService().getShoppingCarts(start, end); 210 } 211 212 /** 213 * Returns the number of shopping carts. 214 * 215 * @return the number of shopping carts 216 * @throws SystemException if a system exception occurred 217 */ 218 public static int getShoppingCartsCount() 219 throws com.liferay.portal.kernel.exception.SystemException { 220 return getService().getShoppingCartsCount(); 221 } 222 223 /** 224 * Updates the shopping cart in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 225 * 226 * @param shoppingCart the shopping cart 227 * @return the shopping cart that was updated 228 * @throws SystemException if a system exception occurred 229 */ 230 public static com.liferay.portlet.shopping.model.ShoppingCart updateShoppingCart( 231 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart) 232 throws com.liferay.portal.kernel.exception.SystemException { 233 return getService().updateShoppingCart(shoppingCart); 234 } 235 236 /** 237 * Returns the Spring bean ID for this bean. 238 * 239 * @return the Spring bean ID for this bean 240 */ 241 public static java.lang.String getBeanIdentifier() { 242 return getService().getBeanIdentifier(); 243 } 244 245 /** 246 * Sets the Spring bean ID for this bean. 247 * 248 * @param beanIdentifier the Spring bean ID for this bean 249 */ 250 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 251 getService().setBeanIdentifier(beanIdentifier); 252 } 253 254 public static void deleteGroupCarts(long groupId) 255 throws com.liferay.portal.kernel.exception.SystemException { 256 getService().deleteGroupCarts(groupId); 257 } 258 259 public static void deleteUserCarts(long userId) 260 throws com.liferay.portal.kernel.exception.SystemException { 261 getService().deleteUserCarts(userId); 262 } 263 264 public static com.liferay.portlet.shopping.model.ShoppingCart getCart( 265 long userId, long groupId) 266 throws com.liferay.portal.kernel.exception.PortalException, 267 com.liferay.portal.kernel.exception.SystemException { 268 return getService().getCart(userId, groupId); 269 } 270 271 public static java.util.Map<com.liferay.portlet.shopping.model.ShoppingCartItem, java.lang.Integer> getItems( 272 long groupId, java.lang.String itemIds) 273 throws com.liferay.portal.kernel.exception.SystemException { 274 return getService().getItems(groupId, itemIds); 275 } 276 277 public static com.liferay.portlet.shopping.model.ShoppingCart updateCart( 278 long userId, long groupId, java.lang.String itemIds, 279 java.lang.String couponCodes, int altShipping, boolean insure) 280 throws com.liferay.portal.kernel.exception.PortalException, 281 com.liferay.portal.kernel.exception.SystemException { 282 return getService() 283 .updateCart(userId, groupId, itemIds, couponCodes, 284 altShipping, insure); 285 } 286 287 public static ShoppingCartLocalService getService() { 288 if (_service == null) { 289 _service = (ShoppingCartLocalService)PortalBeanLocatorUtil.locate(ShoppingCartLocalService.class.getName()); 290 291 ReferenceRegistry.registerReference(ShoppingCartLocalServiceUtil.class, 292 "_service"); 293 } 294 295 return _service; 296 } 297 298 /** 299 * @deprecated 300 */ 301 public void setService(ShoppingCartLocalService service) { 302 } 303 304 private static ShoppingCartLocalService _service; 305 }