001    /**
002     * Copyright (c) 2000-2011 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 coupon local service. This utility wraps {@link com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl} 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 ShoppingCouponLocalService
030     * @see com.liferay.portlet.shopping.service.base.ShoppingCouponLocalServiceBaseImpl
031     * @see com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl
032     * @generated
033     */
034    public class ShoppingCouponLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the shopping coupon to the database. Also notifies the appropriate model listeners.
043            *
044            * @param shoppingCoupon the shopping coupon
045            * @return the shopping coupon that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.shopping.model.ShoppingCoupon addShoppingCoupon(
049                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addShoppingCoupon(shoppingCoupon);
052            }
053    
054            /**
055            * Creates a new shopping coupon with the primary key. Does not add the shopping coupon to the database.
056            *
057            * @param couponId the primary key for the new shopping coupon
058            * @return the new shopping coupon
059            */
060            public static com.liferay.portlet.shopping.model.ShoppingCoupon createShoppingCoupon(
061                    long couponId) {
062                    return getService().createShoppingCoupon(couponId);
063            }
064    
065            /**
066            * Deletes the shopping coupon with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param couponId the primary key of the shopping coupon
069            * @throws PortalException if a shopping coupon with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteShoppingCoupon(long couponId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteShoppingCoupon(couponId);
076            }
077    
078            /**
079            * Deletes the shopping coupon from the database. Also notifies the appropriate model listeners.
080            *
081            * @param shoppingCoupon the shopping coupon
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteShoppingCoupon(
085                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteShoppingCoupon(shoppingCoupon);
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            /**
162            * Returns the shopping coupon with the primary key.
163            *
164            * @param couponId the primary key of the shopping coupon
165            * @return the shopping coupon
166            * @throws PortalException if a shopping coupon with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.shopping.model.ShoppingCoupon getShoppingCoupon(
170                    long couponId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getShoppingCoupon(couponId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the shopping coupons.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of shopping coupons
191            * @param end the upper bound of the range of shopping coupons (not inclusive)
192            * @return the range of shopping coupons
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> getShoppingCoupons(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getShoppingCoupons(start, end);
199            }
200    
201            /**
202            * Returns the number of shopping coupons.
203            *
204            * @return the number of shopping coupons
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getShoppingCouponsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getShoppingCouponsCount();
210            }
211    
212            /**
213            * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param shoppingCoupon the shopping coupon
216            * @return the shopping coupon that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon(
220                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateShoppingCoupon(shoppingCoupon);
223            }
224    
225            /**
226            * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param shoppingCoupon the shopping coupon
229            * @param merge whether to merge the shopping coupon 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.
230            * @return the shopping coupon that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon(
234                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateShoppingCoupon(shoppingCoupon, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.shopping.model.ShoppingCoupon addCoupon(
259                    long userId, java.lang.String code, boolean autoCode,
260                    java.lang.String name, java.lang.String description,
261                    int startDateMonth, int startDateDay, int startDateYear,
262                    int startDateHour, int startDateMinute, int endDateMonth,
263                    int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
264                    boolean neverExpire, boolean active, java.lang.String limitCategories,
265                    java.lang.String limitSkus, double minOrder, double discount,
266                    java.lang.String discountType,
267                    com.liferay.portal.service.ServiceContext serviceContext)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService()
271                                       .addCoupon(userId, code, autoCode, name, description,
272                            startDateMonth, startDateDay, startDateYear, startDateHour,
273                            startDateMinute, endDateMonth, endDateDay, endDateYear,
274                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
275                            limitSkus, minOrder, discount, discountType, serviceContext);
276            }
277    
278            public static void deleteCoupon(long couponId)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService().deleteCoupon(couponId);
282            }
283    
284            public static void deleteCoupon(
285                    com.liferay.portlet.shopping.model.ShoppingCoupon coupon)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    getService().deleteCoupon(coupon);
288            }
289    
290            public static void deleteCoupons(long groupId)
291                    throws com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteCoupons(groupId);
293            }
294    
295            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
296                    long couponId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getCoupon(couponId);
300            }
301    
302            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
303                    java.lang.String code)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService().getCoupon(code);
307            }
308    
309            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> search(
310                    long groupId, long companyId, java.lang.String code, boolean active,
311                    java.lang.String discountType, boolean andOperator, int start, int end)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService()
314                                       .search(groupId, companyId, code, active, discountType,
315                            andOperator, start, end);
316            }
317    
318            public static int searchCount(long groupId, long companyId,
319                    java.lang.String code, boolean active, java.lang.String discountType,
320                    boolean andOperator)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService()
323                                       .searchCount(groupId, companyId, code, active, discountType,
324                            andOperator);
325            }
326    
327            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateCoupon(
328                    long userId, long couponId, java.lang.String name,
329                    java.lang.String description, int startDateMonth, int startDateDay,
330                    int startDateYear, int startDateHour, int startDateMinute,
331                    int endDateMonth, int endDateDay, int endDateYear, int endDateHour,
332                    int endDateMinute, boolean neverExpire, boolean active,
333                    java.lang.String limitCategories, java.lang.String limitSkus,
334                    double minOrder, double discount, java.lang.String discountType,
335                    com.liferay.portal.service.ServiceContext serviceContext)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .updateCoupon(userId, couponId, name, description,
340                            startDateMonth, startDateDay, startDateYear, startDateHour,
341                            startDateMinute, endDateMonth, endDateDay, endDateYear,
342                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
343                            limitSkus, minOrder, discount, discountType, serviceContext);
344            }
345    
346            public static ShoppingCouponLocalService getService() {
347                    if (_service == null) {
348                            _service = (ShoppingCouponLocalService)PortalBeanLocatorUtil.locate(ShoppingCouponLocalService.class.getName());
349    
350                            ReferenceRegistry.registerReference(ShoppingCouponLocalServiceUtil.class,
351                                    "_service");
352                            MethodCache.remove(ShoppingCouponLocalService.class);
353                    }
354    
355                    return _service;
356            }
357    
358            public void setService(ShoppingCouponLocalService service) {
359                    MethodCache.remove(ShoppingCouponLocalService.class);
360    
361                    _service = service;
362    
363                    ReferenceRegistry.registerReference(ShoppingCouponLocalServiceUtil.class,
364                            "_service");
365                    MethodCache.remove(ShoppingCouponLocalService.class);
366            }
367    
368            private static ShoppingCouponLocalService _service;
369    }