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 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            public static com.liferay.portlet.shopping.model.ShoppingCoupon fetchShoppingCoupon(
162                    long couponId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchShoppingCoupon(couponId);
165            }
166    
167            /**
168            * Returns the shopping coupon with the primary key.
169            *
170            * @param couponId the primary key of the shopping coupon
171            * @return the shopping coupon
172            * @throws PortalException if a shopping coupon with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.shopping.model.ShoppingCoupon getShoppingCoupon(
176                    long couponId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getShoppingCoupon(couponId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the shopping coupons.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of shopping coupons
197            * @param end the upper bound of the range of shopping coupons (not inclusive)
198            * @return the range of shopping coupons
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> getShoppingCoupons(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getShoppingCoupons(start, end);
205            }
206    
207            /**
208            * Returns the number of shopping coupons.
209            *
210            * @return the number of shopping coupons
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getShoppingCouponsCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getShoppingCouponsCount();
216            }
217    
218            /**
219            * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param shoppingCoupon the shopping coupon
222            * @return the shopping coupon that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon(
226                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateShoppingCoupon(shoppingCoupon);
229            }
230    
231            /**
232            * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param shoppingCoupon the shopping coupon
235            * @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.
236            * @return the shopping coupon that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon(
240                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updateShoppingCoupon(shoppingCoupon, merge);
244            }
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public static java.lang.String getBeanIdentifier() {
252                    return getService().getBeanIdentifier();
253            }
254    
255            /**
256            * Sets the Spring bean ID for this bean.
257            *
258            * @param beanIdentifier the Spring bean ID for this bean
259            */
260            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
261                    getService().setBeanIdentifier(beanIdentifier);
262            }
263    
264            public static com.liferay.portlet.shopping.model.ShoppingCoupon addCoupon(
265                    long userId, java.lang.String code, boolean autoCode,
266                    java.lang.String name, java.lang.String description,
267                    int startDateMonth, int startDateDay, int startDateYear,
268                    int startDateHour, int startDateMinute, int endDateMonth,
269                    int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
270                    boolean neverExpire, boolean active, java.lang.String limitCategories,
271                    java.lang.String limitSkus, double minOrder, double discount,
272                    java.lang.String discountType,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService()
277                                       .addCoupon(userId, code, autoCode, name, description,
278                            startDateMonth, startDateDay, startDateYear, startDateHour,
279                            startDateMinute, endDateMonth, endDateDay, endDateYear,
280                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
281                            limitSkus, minOrder, discount, discountType, serviceContext);
282            }
283    
284            public static void deleteCoupon(long couponId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    getService().deleteCoupon(couponId);
288            }
289    
290            public static void deleteCoupon(
291                    com.liferay.portlet.shopping.model.ShoppingCoupon coupon)
292                    throws com.liferay.portal.kernel.exception.SystemException {
293                    getService().deleteCoupon(coupon);
294            }
295    
296            public static void deleteCoupons(long groupId)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    getService().deleteCoupons(groupId);
299            }
300    
301            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
302                    long couponId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    return getService().getCoupon(couponId);
306            }
307    
308            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
309                    java.lang.String code)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getCoupon(code);
313            }
314    
315            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> search(
316                    long groupId, long companyId, java.lang.String code, boolean active,
317                    java.lang.String discountType, boolean andOperator, int start, int end)
318                    throws com.liferay.portal.kernel.exception.SystemException {
319                    return getService()
320                                       .search(groupId, companyId, code, active, discountType,
321                            andOperator, start, end);
322            }
323    
324            public static int searchCount(long groupId, long companyId,
325                    java.lang.String code, boolean active, java.lang.String discountType,
326                    boolean andOperator)
327                    throws com.liferay.portal.kernel.exception.SystemException {
328                    return getService()
329                                       .searchCount(groupId, companyId, code, active, discountType,
330                            andOperator);
331            }
332    
333            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateCoupon(
334                    long userId, long couponId, java.lang.String name,
335                    java.lang.String description, int startDateMonth, int startDateDay,
336                    int startDateYear, int startDateHour, int startDateMinute,
337                    int endDateMonth, int endDateDay, int endDateYear, int endDateHour,
338                    int endDateMinute, boolean neverExpire, boolean active,
339                    java.lang.String limitCategories, java.lang.String limitSkus,
340                    double minOrder, double discount, java.lang.String discountType,
341                    com.liferay.portal.service.ServiceContext serviceContext)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    return getService()
345                                       .updateCoupon(userId, couponId, name, description,
346                            startDateMonth, startDateDay, startDateYear, startDateHour,
347                            startDateMinute, endDateMonth, endDateDay, endDateYear,
348                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
349                            limitSkus, minOrder, discount, discountType, serviceContext);
350            }
351    
352            public static ShoppingCouponLocalService getService() {
353                    if (_service == null) {
354                            _service = (ShoppingCouponLocalService)PortalBeanLocatorUtil.locate(ShoppingCouponLocalService.class.getName());
355    
356                            ReferenceRegistry.registerReference(ShoppingCouponLocalServiceUtil.class,
357                                    "_service");
358                            MethodCache.remove(ShoppingCouponLocalService.class);
359                    }
360    
361                    return _service;
362            }
363    
364            public void setService(ShoppingCouponLocalService service) {
365                    MethodCache.remove(ShoppingCouponLocalService.class);
366    
367                    _service = service;
368    
369                    ReferenceRegistry.registerReference(ShoppingCouponLocalServiceUtil.class,
370                            "_service");
371                    MethodCache.remove(ShoppingCouponLocalService.class);
372            }
373    
374            private static ShoppingCouponLocalService _service;
375    }