001    /**
002     * Copyright (c) 2000-2013 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     * Provides the local service utility for ShoppingCart. This utility wraps
022     * {@link com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
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            * @return the shopping cart that was removed
070            * @throws PortalException if a shopping cart with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart(
074                    long cartId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteShoppingCart(cartId);
078            }
079    
080            /**
081            * Deletes the shopping cart from the database. Also notifies the appropriate model listeners.
082            *
083            * @param shoppingCart the shopping cart
084            * @return the shopping cart that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart(
088                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteShoppingCart(shoppingCart);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portlet.shopping.model.ShoppingCart fetchShoppingCart(
184                    long cartId) throws com.liferay.portal.kernel.exception.SystemException {
185                    return getService().fetchShoppingCart(cartId);
186            }
187    
188            /**
189            * Returns the shopping cart with the primary key.
190            *
191            * @param cartId the primary key of the shopping cart
192            * @return the shopping cart
193            * @throws PortalException if a shopping cart with the primary key could not be found
194            * @throws SystemException if a system exception occurred
195            */
196            public static com.liferay.portlet.shopping.model.ShoppingCart getShoppingCart(
197                    long cartId)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getShoppingCart(cartId);
201            }
202    
203            public static com.liferay.portal.model.PersistedModel getPersistedModel(
204                    java.io.Serializable primaryKeyObj)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException {
207                    return getService().getPersistedModel(primaryKeyObj);
208            }
209    
210            /**
211            * Returns a range of all the shopping carts.
212            *
213            * <p>
214            * 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.
215            * </p>
216            *
217            * @param start the lower bound of the range of shopping carts
218            * @param end the upper bound of the range of shopping carts (not inclusive)
219            * @return the range of shopping carts
220            * @throws SystemException if a system exception occurred
221            */
222            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCart> getShoppingCarts(
223                    int start, int end)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getShoppingCarts(start, end);
226            }
227    
228            /**
229            * Returns the number of shopping carts.
230            *
231            * @return the number of shopping carts
232            * @throws SystemException if a system exception occurred
233            */
234            public static int getShoppingCartsCount()
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getShoppingCartsCount();
237            }
238    
239            /**
240            * Updates the shopping cart in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param shoppingCart the shopping cart
243            * @return the shopping cart that was updated
244            * @throws SystemException if a system exception occurred
245            */
246            public static com.liferay.portlet.shopping.model.ShoppingCart updateShoppingCart(
247                    com.liferay.portlet.shopping.model.ShoppingCart shoppingCart)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateShoppingCart(shoppingCart);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static void deleteGroupCarts(long groupId)
271                    throws com.liferay.portal.kernel.exception.SystemException {
272                    getService().deleteGroupCarts(groupId);
273            }
274    
275            public static void deleteUserCarts(long userId)
276                    throws com.liferay.portal.kernel.exception.SystemException {
277                    getService().deleteUserCarts(userId);
278            }
279    
280            public static com.liferay.portlet.shopping.model.ShoppingCart getCart(
281                    long userId, long groupId)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService().getCart(userId, groupId);
285            }
286    
287            public static java.util.Map<com.liferay.portlet.shopping.model.ShoppingCartItem, java.lang.Integer> getItems(
288                    long groupId, java.lang.String itemIds)
289                    throws com.liferay.portal.kernel.exception.SystemException {
290                    return getService().getItems(groupId, itemIds);
291            }
292    
293            public static com.liferay.portlet.shopping.model.ShoppingCart updateCart(
294                    long userId, long groupId, java.lang.String itemIds,
295                    java.lang.String couponCodes, int altShipping, boolean insure)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .updateCart(userId, groupId, itemIds, couponCodes,
300                            altShipping, insure);
301            }
302    
303            public static ShoppingCartLocalService getService() {
304                    if (_service == null) {
305                            _service = (ShoppingCartLocalService)PortalBeanLocatorUtil.locate(ShoppingCartLocalService.class.getName());
306    
307                            ReferenceRegistry.registerReference(ShoppingCartLocalServiceUtil.class,
308                                    "_service");
309                    }
310    
311                    return _service;
312            }
313    
314            /**
315             * @deprecated As of 6.2.0
316             */
317            public void setService(ShoppingCartLocalService service) {
318            }
319    
320            private static ShoppingCartLocalService _service;
321    }