001    /**
002     * Copyright (c) 2000-present 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.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.model.BaseModel;
021    import com.liferay.portal.model.CacheModel;
022    import com.liferay.portal.model.GroupedModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    import java.util.Date;
030    
031    /**
032     * The base model interface for the ShoppingCoupon service. Represents a row in the "ShoppingCoupon" database table, with each column mapped to a property of this class.
033     *
034     * <p>
035     * This interface and its corresponding implementation {@link com.liferay.portlet.shopping.model.impl.ShoppingCouponModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portlet.shopping.model.impl.ShoppingCouponImpl}.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see ShoppingCoupon
040     * @see com.liferay.portlet.shopping.model.impl.ShoppingCouponImpl
041     * @see com.liferay.portlet.shopping.model.impl.ShoppingCouponModelImpl
042     * @generated
043     */
044    @ProviderType
045    public interface ShoppingCouponModel extends BaseModel<ShoppingCoupon>,
046            GroupedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a shopping coupon model instance should use the {@link ShoppingCoupon} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this shopping coupon.
055             *
056             * @return the primary key of this shopping coupon
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this shopping coupon.
062             *
063             * @param primaryKey the primary key of this shopping coupon
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the coupon ID of this shopping coupon.
069             *
070             * @return the coupon ID of this shopping coupon
071             */
072            public long getCouponId();
073    
074            /**
075             * Sets the coupon ID of this shopping coupon.
076             *
077             * @param couponId the coupon ID of this shopping coupon
078             */
079            public void setCouponId(long couponId);
080    
081            /**
082             * Returns the group ID of this shopping coupon.
083             *
084             * @return the group ID of this shopping coupon
085             */
086            @Override
087            public long getGroupId();
088    
089            /**
090             * Sets the group ID of this shopping coupon.
091             *
092             * @param groupId the group ID of this shopping coupon
093             */
094            @Override
095            public void setGroupId(long groupId);
096    
097            /**
098             * Returns the company ID of this shopping coupon.
099             *
100             * @return the company ID of this shopping coupon
101             */
102            @Override
103            public long getCompanyId();
104    
105            /**
106             * Sets the company ID of this shopping coupon.
107             *
108             * @param companyId the company ID of this shopping coupon
109             */
110            @Override
111            public void setCompanyId(long companyId);
112    
113            /**
114             * Returns the user ID of this shopping coupon.
115             *
116             * @return the user ID of this shopping coupon
117             */
118            @Override
119            public long getUserId();
120    
121            /**
122             * Sets the user ID of this shopping coupon.
123             *
124             * @param userId the user ID of this shopping coupon
125             */
126            @Override
127            public void setUserId(long userId);
128    
129            /**
130             * Returns the user uuid of this shopping coupon.
131             *
132             * @return the user uuid of this shopping coupon
133             */
134            @Override
135            public String getUserUuid();
136    
137            /**
138             * Sets the user uuid of this shopping coupon.
139             *
140             * @param userUuid the user uuid of this shopping coupon
141             */
142            @Override
143            public void setUserUuid(String userUuid);
144    
145            /**
146             * Returns the user name of this shopping coupon.
147             *
148             * @return the user name of this shopping coupon
149             */
150            @AutoEscape
151            @Override
152            public String getUserName();
153    
154            /**
155             * Sets the user name of this shopping coupon.
156             *
157             * @param userName the user name of this shopping coupon
158             */
159            @Override
160            public void setUserName(String userName);
161    
162            /**
163             * Returns the create date of this shopping coupon.
164             *
165             * @return the create date of this shopping coupon
166             */
167            @Override
168            public Date getCreateDate();
169    
170            /**
171             * Sets the create date of this shopping coupon.
172             *
173             * @param createDate the create date of this shopping coupon
174             */
175            @Override
176            public void setCreateDate(Date createDate);
177    
178            /**
179             * Returns the modified date of this shopping coupon.
180             *
181             * @return the modified date of this shopping coupon
182             */
183            @Override
184            public Date getModifiedDate();
185    
186            /**
187             * Sets the modified date of this shopping coupon.
188             *
189             * @param modifiedDate the modified date of this shopping coupon
190             */
191            @Override
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Returns the code of this shopping coupon.
196             *
197             * @return the code of this shopping coupon
198             */
199            @AutoEscape
200            public String getCode();
201    
202            /**
203             * Sets the code of this shopping coupon.
204             *
205             * @param code the code of this shopping coupon
206             */
207            public void setCode(String code);
208    
209            /**
210             * Returns the name of this shopping coupon.
211             *
212             * @return the name of this shopping coupon
213             */
214            @AutoEscape
215            public String getName();
216    
217            /**
218             * Sets the name of this shopping coupon.
219             *
220             * @param name the name of this shopping coupon
221             */
222            public void setName(String name);
223    
224            /**
225             * Returns the description of this shopping coupon.
226             *
227             * @return the description of this shopping coupon
228             */
229            @AutoEscape
230            public String getDescription();
231    
232            /**
233             * Sets the description of this shopping coupon.
234             *
235             * @param description the description of this shopping coupon
236             */
237            public void setDescription(String description);
238    
239            /**
240             * Returns the start date of this shopping coupon.
241             *
242             * @return the start date of this shopping coupon
243             */
244            public Date getStartDate();
245    
246            /**
247             * Sets the start date of this shopping coupon.
248             *
249             * @param startDate the start date of this shopping coupon
250             */
251            public void setStartDate(Date startDate);
252    
253            /**
254             * Returns the end date of this shopping coupon.
255             *
256             * @return the end date of this shopping coupon
257             */
258            public Date getEndDate();
259    
260            /**
261             * Sets the end date of this shopping coupon.
262             *
263             * @param endDate the end date of this shopping coupon
264             */
265            public void setEndDate(Date endDate);
266    
267            /**
268             * Returns the active of this shopping coupon.
269             *
270             * @return the active of this shopping coupon
271             */
272            public boolean getActive();
273    
274            /**
275             * Returns <code>true</code> if this shopping coupon is active.
276             *
277             * @return <code>true</code> if this shopping coupon is active; <code>false</code> otherwise
278             */
279            public boolean isActive();
280    
281            /**
282             * Sets whether this shopping coupon is active.
283             *
284             * @param active the active of this shopping coupon
285             */
286            public void setActive(boolean active);
287    
288            /**
289             * Returns the limit categories of this shopping coupon.
290             *
291             * @return the limit categories of this shopping coupon
292             */
293            @AutoEscape
294            public String getLimitCategories();
295    
296            /**
297             * Sets the limit categories of this shopping coupon.
298             *
299             * @param limitCategories the limit categories of this shopping coupon
300             */
301            public void setLimitCategories(String limitCategories);
302    
303            /**
304             * Returns the limit skus of this shopping coupon.
305             *
306             * @return the limit skus of this shopping coupon
307             */
308            @AutoEscape
309            public String getLimitSkus();
310    
311            /**
312             * Sets the limit skus of this shopping coupon.
313             *
314             * @param limitSkus the limit skus of this shopping coupon
315             */
316            public void setLimitSkus(String limitSkus);
317    
318            /**
319             * Returns the min order of this shopping coupon.
320             *
321             * @return the min order of this shopping coupon
322             */
323            public double getMinOrder();
324    
325            /**
326             * Sets the min order of this shopping coupon.
327             *
328             * @param minOrder the min order of this shopping coupon
329             */
330            public void setMinOrder(double minOrder);
331    
332            /**
333             * Returns the discount of this shopping coupon.
334             *
335             * @return the discount of this shopping coupon
336             */
337            public double getDiscount();
338    
339            /**
340             * Sets the discount of this shopping coupon.
341             *
342             * @param discount the discount of this shopping coupon
343             */
344            public void setDiscount(double discount);
345    
346            /**
347             * Returns the discount type of this shopping coupon.
348             *
349             * @return the discount type of this shopping coupon
350             */
351            @AutoEscape
352            public String getDiscountType();
353    
354            /**
355             * Sets the discount type of this shopping coupon.
356             *
357             * @param discountType the discount type of this shopping coupon
358             */
359            public void setDiscountType(String discountType);
360    
361            @Override
362            public boolean isNew();
363    
364            @Override
365            public void setNew(boolean n);
366    
367            @Override
368            public boolean isCachedModel();
369    
370            @Override
371            public void setCachedModel(boolean cachedModel);
372    
373            @Override
374            public boolean isEscapedModel();
375    
376            @Override
377            public Serializable getPrimaryKeyObj();
378    
379            @Override
380            public void setPrimaryKeyObj(Serializable primaryKeyObj);
381    
382            @Override
383            public ExpandoBridge getExpandoBridge();
384    
385            @Override
386            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
387    
388            @Override
389            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
390    
391            @Override
392            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
393    
394            @Override
395            public Object clone();
396    
397            @Override
398            public int compareTo(
399                    com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon);
400    
401            @Override
402            public int hashCode();
403    
404            @Override
405            public CacheModel<com.liferay.portlet.shopping.model.ShoppingCoupon> toCacheModel();
406    
407            @Override
408            public com.liferay.portlet.shopping.model.ShoppingCoupon toEscapedModel();
409    
410            @Override
411            public com.liferay.portlet.shopping.model.ShoppingCoupon toUnescapedModel();
412    
413            @Override
414            public String toString();
415    
416            @Override
417            public String toXmlString();
418    }