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