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