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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see ShoppingCartLocalService
030     * @see com.liferay.portlet.shopping.service.base.ShoppingCartLocalServiceBaseImpl
031     * @see com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl
032     * @generated
033     */
034    public class ShoppingCartLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the shopping cart to the database. Also notifies the appropriate model listeners.
043            *
044            * @param shoppingCart the shopping cart
045            * @return the shopping cart that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.shopping.model.ShoppingCart addShoppingCart(
049                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addShoppingCart(shoppingCart);
052            }
053    
054            /**
055            * Creates a new shopping cart with the primary key. Does not add the shopping cart to the database.
056            *
057            * @param cartId the primary key for the new shopping cart
058            * @return the new shopping cart
059            */
060            public static com.liferay.portlet.shopping.model.ShoppingCart createShoppingCart(
061                    long cartId) {
062                    return getService().createShoppingCart(cartId);
063            }
064    
065            /**
066            * Deletes the shopping cart with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param cartId the primary key of the shopping cart
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 void deleteShoppingCart(long cartId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteShoppingCart(cartId);
076            }
077    
078            /**
079            * Deletes the shopping cart from the database. Also notifies the appropriate model listeners.
080            *
081            * @param shoppingCart the shopping cart
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteShoppingCart(
085                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteShoppingCart(shoppingCart);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portlet.shopping.model.ShoppingCart fetchShoppingCart(
162                    long cartId) throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService().fetchShoppingCart(cartId);
164            }
165    
166            /**
167            * Returns the shopping cart with the primary key.
168            *
169            * @param cartId the primary key of the shopping cart
170            * @return the shopping cart
171            * @throws PortalException if a shopping cart with the primary key could not be found
172            * @throws SystemException if a system exception occurred
173            */
174            public static com.liferay.portlet.shopping.model.ShoppingCart getShoppingCart(
175                    long cartId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getShoppingCart(cartId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the shopping carts.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of shopping carts
196            * @param end the upper bound of the range of shopping carts (not inclusive)
197            * @return the range of shopping carts
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCart> getShoppingCarts(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getShoppingCarts(start, end);
204            }
205    
206            /**
207            * Returns the number of shopping carts.
208            *
209            * @return the number of shopping carts
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getShoppingCartsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getShoppingCartsCount();
215            }
216    
217            /**
218            * Updates the shopping cart in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param shoppingCart the shopping cart
221            * @return the shopping cart that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.shopping.model.ShoppingCart updateShoppingCart(
225                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateShoppingCart(shoppingCart);
228            }
229    
230            /**
231            * Updates the shopping cart in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param shoppingCart the shopping cart
234            * @param merge whether to merge the shopping cart with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
235            * @return the shopping cart that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.shopping.model.ShoppingCart updateShoppingCart(
239                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateShoppingCart(shoppingCart, merge);
243            }
244    
245            /**
246            * Returns the Spring bean ID for this bean.
247            *
248            * @return the Spring bean ID for this bean
249            */
250            public static java.lang.String getBeanIdentifier() {
251                    return getService().getBeanIdentifier();
252            }
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
260                    getService().setBeanIdentifier(beanIdentifier);
261            }
262    
263            public static void deleteGroupCarts(long groupId)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    getService().deleteGroupCarts(groupId);
266            }
267    
268            public static void deleteUserCarts(long userId)
269                    throws com.liferay.portal.kernel.exception.SystemException {
270                    getService().deleteUserCarts(userId);
271            }
272    
273            public static com.liferay.portlet.shopping.model.ShoppingCart getCart(
274                    long userId, long groupId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService().getCart(userId, groupId);
278            }
279    
280            public static java.util.Map<com.liferay.portlet.shopping.model.ShoppingCartItem, java.lang.Integer> getItems(
281                    long groupId, java.lang.String itemIds)
282                    throws com.liferay.portal.kernel.exception.SystemException {
283                    return getService().getItems(groupId, itemIds);
284            }
285    
286            public static com.liferay.portlet.shopping.model.ShoppingCart updateCart(
287                    long userId, long groupId, java.lang.String itemIds,
288                    java.lang.String couponCodes, int altShipping, boolean insure)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    return getService()
292                                       .updateCart(userId, groupId, itemIds, couponCodes,
293                            altShipping, insure);
294            }
295    
296            public static ShoppingCartLocalService getService() {
297                    if (_service == null) {
298                            _service = (ShoppingCartLocalService)PortalBeanLocatorUtil.locate(ShoppingCartLocalService.class.getName());
299    
300                            ReferenceRegistry.registerReference(ShoppingCartLocalServiceUtil.class,
301                                    "_service");
302                            MethodCache.remove(ShoppingCartLocalService.class);
303                    }
304    
305                    return _service;
306            }
307    
308            public void setService(ShoppingCartLocalService service) {
309                    MethodCache.remove(ShoppingCartLocalService.class);
310    
311                    _service = service;
312    
313                    ReferenceRegistry.registerReference(ShoppingCartLocalServiceUtil.class,
314                            "_service");
315                    MethodCache.remove(ShoppingCartLocalService.class);
316            }
317    
318            private static ShoppingCartLocalService _service;
319    }