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.persistence;
016    
017    import com.liferay.portal.service.persistence.BasePersistence;
018    
019    import com.liferay.portlet.shopping.model.ShoppingCoupon;
020    
021    /**
022     * The persistence interface for the shopping coupon service.
023     *
024     * <p>
025     * Caching information and settings can be found in <code>portal.properties</code>
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see ShoppingCouponPersistenceImpl
030     * @see ShoppingCouponUtil
031     * @generated
032     */
033    public interface ShoppingCouponPersistence extends BasePersistence<ShoppingCoupon> {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify or reference this interface directly. Always use {@link ShoppingCouponUtil} to access the shopping coupon persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
038             */
039    
040            /**
041            * Caches the shopping coupon in the entity cache if it is enabled.
042            *
043            * @param shoppingCoupon the shopping coupon
044            */
045            public void cacheResult(
046                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon);
047    
048            /**
049            * Caches the shopping coupons in the entity cache if it is enabled.
050            *
051            * @param shoppingCoupons the shopping coupons
052            */
053            public void cacheResult(
054                    java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> shoppingCoupons);
055    
056            /**
057            * Creates a new shopping coupon with the primary key. Does not add the shopping coupon to the database.
058            *
059            * @param couponId the primary key for the new shopping coupon
060            * @return the new shopping coupon
061            */
062            public com.liferay.portlet.shopping.model.ShoppingCoupon create(
063                    long couponId);
064    
065            /**
066            * Removes 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 com.liferay.portlet.shopping.NoSuchCouponException if a shopping coupon with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portlet.shopping.model.ShoppingCoupon remove(
074                    long couponId)
075                    throws com.liferay.portal.kernel.exception.SystemException,
076                            com.liferay.portlet.shopping.NoSuchCouponException;
077    
078            public com.liferay.portlet.shopping.model.ShoppingCoupon updateImpl(
079                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon,
080                    boolean merge)
081                    throws com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Returns the shopping coupon with the primary key or throws a {@link com.liferay.portlet.shopping.NoSuchCouponException} if it could not be found.
085            *
086            * @param couponId the primary key of the shopping coupon
087            * @return the shopping coupon
088            * @throws com.liferay.portlet.shopping.NoSuchCouponException if a shopping coupon with the primary key could not be found
089            * @throws SystemException if a system exception occurred
090            */
091            public com.liferay.portlet.shopping.model.ShoppingCoupon findByPrimaryKey(
092                    long couponId)
093                    throws com.liferay.portal.kernel.exception.SystemException,
094                            com.liferay.portlet.shopping.NoSuchCouponException;
095    
096            /**
097            * Returns the shopping coupon with the primary key or returns <code>null</code> if it could not be found.
098            *
099            * @param couponId the primary key of the shopping coupon
100            * @return the shopping coupon, or <code>null</code> if a shopping coupon with the primary key could not be found
101            * @throws SystemException if a system exception occurred
102            */
103            public com.liferay.portlet.shopping.model.ShoppingCoupon fetchByPrimaryKey(
104                    long couponId)
105                    throws com.liferay.portal.kernel.exception.SystemException;
106    
107            /**
108            * Returns all the shopping coupons where groupId = &#63;.
109            *
110            * @param groupId the group ID
111            * @return the matching shopping coupons
112            * @throws SystemException if a system exception occurred
113            */
114            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findByGroupId(
115                    long groupId)
116                    throws com.liferay.portal.kernel.exception.SystemException;
117    
118            /**
119            * Returns a range of all the shopping coupons where groupId = &#63;.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param groupId the group ID
126            * @param start the lower bound of the range of shopping coupons
127            * @param end the upper bound of the range of shopping coupons (not inclusive)
128            * @return the range of matching shopping coupons
129            * @throws SystemException if a system exception occurred
130            */
131            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findByGroupId(
132                    long groupId, int start, int end)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Returns an ordered range of all the shopping coupons where groupId = &#63;.
137            *
138            * <p>
139            * 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.
140            * </p>
141            *
142            * @param groupId the group ID
143            * @param start the lower bound of the range of shopping coupons
144            * @param end the upper bound of the range of shopping coupons (not inclusive)
145            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
146            * @return the ordered range of matching shopping coupons
147            * @throws SystemException if a system exception occurred
148            */
149            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findByGroupId(
150                    long groupId, int start, int end,
151                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the first shopping coupon in the ordered set where groupId = &#63;.
156            *
157            * <p>
158            * 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.
159            * </p>
160            *
161            * @param groupId the group ID
162            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
163            * @return the first matching shopping coupon
164            * @throws com.liferay.portlet.shopping.NoSuchCouponException if a matching shopping coupon could not be found
165            * @throws SystemException if a system exception occurred
166            */
167            public com.liferay.portlet.shopping.model.ShoppingCoupon findByGroupId_First(
168                    long groupId,
169                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
170                    throws com.liferay.portal.kernel.exception.SystemException,
171                            com.liferay.portlet.shopping.NoSuchCouponException;
172    
173            /**
174            * Returns the last shopping coupon in the ordered set where groupId = &#63;.
175            *
176            * <p>
177            * 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.
178            * </p>
179            *
180            * @param groupId the group ID
181            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
182            * @return the last matching shopping coupon
183            * @throws com.liferay.portlet.shopping.NoSuchCouponException if a matching shopping coupon could not be found
184            * @throws SystemException if a system exception occurred
185            */
186            public com.liferay.portlet.shopping.model.ShoppingCoupon findByGroupId_Last(
187                    long groupId,
188                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
189                    throws com.liferay.portal.kernel.exception.SystemException,
190                            com.liferay.portlet.shopping.NoSuchCouponException;
191    
192            /**
193            * Returns the shopping coupons before and after the current shopping coupon in the ordered set where groupId = &#63;.
194            *
195            * <p>
196            * 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.
197            * </p>
198            *
199            * @param couponId the primary key of the current shopping coupon
200            * @param groupId the group ID
201            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
202            * @return the previous, current, and next shopping coupon
203            * @throws com.liferay.portlet.shopping.NoSuchCouponException if a shopping coupon with the primary key could not be found
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portlet.shopping.model.ShoppingCoupon[] findByGroupId_PrevAndNext(
207                    long couponId, long groupId,
208                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
209                    throws com.liferay.portal.kernel.exception.SystemException,
210                            com.liferay.portlet.shopping.NoSuchCouponException;
211    
212            /**
213            * Returns the shopping coupon where code = &#63; or throws a {@link com.liferay.portlet.shopping.NoSuchCouponException} if it could not be found.
214            *
215            * @param code the code
216            * @return the matching shopping coupon
217            * @throws com.liferay.portlet.shopping.NoSuchCouponException if a matching shopping coupon could not be found
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portlet.shopping.model.ShoppingCoupon findByCode(
221                    java.lang.String code)
222                    throws com.liferay.portal.kernel.exception.SystemException,
223                            com.liferay.portlet.shopping.NoSuchCouponException;
224    
225            /**
226            * Returns the shopping coupon where code = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
227            *
228            * @param code the code
229            * @return the matching shopping coupon, or <code>null</code> if a matching shopping coupon could not be found
230            * @throws SystemException if a system exception occurred
231            */
232            public com.liferay.portlet.shopping.model.ShoppingCoupon fetchByCode(
233                    java.lang.String code)
234                    throws com.liferay.portal.kernel.exception.SystemException;
235    
236            /**
237            * Returns the shopping coupon where code = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
238            *
239            * @param code the code
240            * @param retrieveFromCache whether to use the finder cache
241            * @return the matching shopping coupon, or <code>null</code> if a matching shopping coupon could not be found
242            * @throws SystemException if a system exception occurred
243            */
244            public com.liferay.portlet.shopping.model.ShoppingCoupon fetchByCode(
245                    java.lang.String code, boolean retrieveFromCache)
246                    throws com.liferay.portal.kernel.exception.SystemException;
247    
248            /**
249            * Returns all the shopping coupons.
250            *
251            * @return the shopping coupons
252            * @throws SystemException if a system exception occurred
253            */
254            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findAll()
255                    throws com.liferay.portal.kernel.exception.SystemException;
256    
257            /**
258            * Returns a range of all the shopping coupons.
259            *
260            * <p>
261            * 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.
262            * </p>
263            *
264            * @param start the lower bound of the range of shopping coupons
265            * @param end the upper bound of the range of shopping coupons (not inclusive)
266            * @return the range of shopping coupons
267            * @throws SystemException if a system exception occurred
268            */
269            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findAll(
270                    int start, int end)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Returns an ordered range of all the shopping coupons.
275            *
276            * <p>
277            * 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.
278            * </p>
279            *
280            * @param start the lower bound of the range of shopping coupons
281            * @param end the upper bound of the range of shopping coupons (not inclusive)
282            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
283            * @return the ordered range of shopping coupons
284            * @throws SystemException if a system exception occurred
285            */
286            public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> findAll(
287                    int start, int end,
288                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            /**
292            * Removes all the shopping coupons where groupId = &#63; from the database.
293            *
294            * @param groupId the group ID
295            * @throws SystemException if a system exception occurred
296            */
297            public void removeByGroupId(long groupId)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    
300            /**
301            * Removes the shopping coupon where code = &#63; from the database.
302            *
303            * @param code the code
304            * @throws SystemException if a system exception occurred
305            */
306            public void removeByCode(java.lang.String code)
307                    throws com.liferay.portal.kernel.exception.SystemException,
308                            com.liferay.portlet.shopping.NoSuchCouponException;
309    
310            /**
311            * Removes all the shopping coupons from the database.
312            *
313            * @throws SystemException if a system exception occurred
314            */
315            public void removeAll()
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            /**
319            * Returns the number of shopping coupons where groupId = &#63;.
320            *
321            * @param groupId the group ID
322            * @return the number of matching shopping coupons
323            * @throws SystemException if a system exception occurred
324            */
325            public int countByGroupId(long groupId)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            /**
329            * Returns the number of shopping coupons where code = &#63;.
330            *
331            * @param code the code
332            * @return the number of matching shopping coupons
333            * @throws SystemException if a system exception occurred
334            */
335            public int countByCode(java.lang.String code)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            /**
339            * Returns the number of shopping coupons.
340            *
341            * @return the number of shopping coupons
342            * @throws SystemException if a system exception occurred
343            */
344            public int countAll()
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    }