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