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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for ShoppingCoupon. This utility wraps
024     * {@link com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see ShoppingCouponLocalService
032     * @see com.liferay.portlet.shopping.service.base.ShoppingCouponLocalServiceBaseImpl
033     * @see com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class ShoppingCouponLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * 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.
042             */
043    
044            /**
045            * Adds the shopping coupon to the database. Also notifies the appropriate model listeners.
046            *
047            * @param shoppingCoupon the shopping coupon
048            * @return the shopping coupon that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.shopping.model.ShoppingCoupon addShoppingCoupon(
052                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addShoppingCoupon(shoppingCoupon);
055            }
056    
057            /**
058            * Creates a new shopping coupon with the primary key. Does not add the shopping coupon to the database.
059            *
060            * @param couponId the primary key for the new shopping coupon
061            * @return the new shopping coupon
062            */
063            public static com.liferay.portlet.shopping.model.ShoppingCoupon createShoppingCoupon(
064                    long couponId) {
065                    return getService().createShoppingCoupon(couponId);
066            }
067    
068            /**
069            * Deletes the shopping coupon with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param couponId the primary key of the shopping coupon
072            * @return the shopping coupon that was removed
073            * @throws PortalException if a shopping coupon with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon(
077                    long couponId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteShoppingCoupon(couponId);
081            }
082    
083            /**
084            * Deletes the shopping coupon from the database. Also notifies the appropriate model listeners.
085            *
086            * @param shoppingCoupon the shopping coupon
087            * @return the shopping coupon that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon(
091                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteShoppingCoupon(shoppingCoupon);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.ShoppingCouponModelImpl}. 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.ShoppingCouponModelImpl}. 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.shopping.model.ShoppingCoupon fetchShoppingCoupon(
187                    long couponId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchShoppingCoupon(couponId);
190            }
191    
192            /**
193            * Returns the shopping coupon with the primary key.
194            *
195            * @param couponId the primary key of the shopping coupon
196            * @return the shopping coupon
197            * @throws PortalException if a shopping coupon with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.shopping.model.ShoppingCoupon getShoppingCoupon(
201                    long couponId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getShoppingCoupon(couponId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the shopping coupons.
216            *
217            * <p>
218            * 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.ShoppingCouponModelImpl}. 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of shopping coupons
222            * @param end the upper bound of the range of shopping coupons (not inclusive)
223            * @return the range of shopping coupons
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> getShoppingCoupons(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getShoppingCoupons(start, end);
230            }
231    
232            /**
233            * Returns the number of shopping coupons.
234            *
235            * @return the number of shopping coupons
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getShoppingCouponsCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getShoppingCouponsCount();
241            }
242    
243            /**
244            * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param shoppingCoupon the shopping coupon
247            * @return the shopping coupon that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon(
251                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateShoppingCoupon(shoppingCoupon);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.shopping.model.ShoppingCoupon addCoupon(
275                    long userId, java.lang.String code, boolean autoCode,
276                    java.lang.String name, java.lang.String description,
277                    int startDateMonth, int startDateDay, int startDateYear,
278                    int startDateHour, int startDateMinute, int endDateMonth,
279                    int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
280                    boolean neverExpire, boolean active, java.lang.String limitCategories,
281                    java.lang.String limitSkus, double minOrder, double discount,
282                    java.lang.String discountType,
283                    com.liferay.portal.service.ServiceContext serviceContext)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService()
287                                       .addCoupon(userId, code, autoCode, name, description,
288                            startDateMonth, startDateDay, startDateYear, startDateHour,
289                            startDateMinute, endDateMonth, endDateDay, endDateYear,
290                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
291                            limitSkus, minOrder, discount, discountType, serviceContext);
292            }
293    
294            public static void deleteCoupon(long couponId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteCoupon(couponId);
298            }
299    
300            public static void deleteCoupon(
301                    com.liferay.portlet.shopping.model.ShoppingCoupon coupon)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteCoupon(coupon);
304            }
305    
306            public static void deleteCoupons(long groupId)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    getService().deleteCoupons(groupId);
309            }
310    
311            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
312                    long couponId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    return getService().getCoupon(couponId);
316            }
317    
318            public static com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon(
319                    java.lang.String code)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    return getService().getCoupon(code);
323            }
324    
325            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> search(
326                    long groupId, long companyId, java.lang.String code, boolean active,
327                    java.lang.String discountType, boolean andOperator, int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    return getService()
330                                       .search(groupId, companyId, code, active, discountType,
331                            andOperator, start, end);
332            }
333    
334            public static int searchCount(long groupId, long companyId,
335                    java.lang.String code, boolean active, java.lang.String discountType,
336                    boolean andOperator)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .searchCount(groupId, companyId, code, active, discountType,
340                            andOperator);
341            }
342    
343            public static com.liferay.portlet.shopping.model.ShoppingCoupon updateCoupon(
344                    long userId, long couponId, java.lang.String name,
345                    java.lang.String description, int startDateMonth, int startDateDay,
346                    int startDateYear, int startDateHour, int startDateMinute,
347                    int endDateMonth, int endDateDay, int endDateYear, int endDateHour,
348                    int endDateMinute, boolean neverExpire, boolean active,
349                    java.lang.String limitCategories, java.lang.String limitSkus,
350                    double minOrder, double discount, java.lang.String discountType,
351                    com.liferay.portal.service.ServiceContext serviceContext)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    return getService()
355                                       .updateCoupon(userId, couponId, name, description,
356                            startDateMonth, startDateDay, startDateYear, startDateHour,
357                            startDateMinute, endDateMonth, endDateDay, endDateYear,
358                            endDateHour, endDateMinute, neverExpire, active, limitCategories,
359                            limitSkus, minOrder, discount, discountType, serviceContext);
360            }
361    
362            public static ShoppingCouponLocalService getService() {
363                    if (_service == null) {
364                            _service = (ShoppingCouponLocalService)PortalBeanLocatorUtil.locate(ShoppingCouponLocalService.class.getName());
365    
366                            ReferenceRegistry.registerReference(ShoppingCouponLocalServiceUtil.class,
367                                    "_service");
368                    }
369    
370                    return _service;
371            }
372    
373            /**
374             * @deprecated As of 6.2.0
375             */
376            public void setService(ShoppingCouponLocalService service) {
377            }
378    
379            private static ShoppingCouponLocalService _service;
380    }