001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.shopping.model;
016    
017    import com.liferay.portal.kernel.annotation.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    
028    /**
029     * 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.
030     *
031     * <p>
032     * 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}.
033     * </p>
034     *
035     * <p>
036     * Never modify or reference this interface directly. All methods that expect a shopping coupon model instance should use the {@link ShoppingCoupon} interface instead.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see ShoppingCoupon
041     * @see com.liferay.portlet.shopping.model.impl.ShoppingCouponImpl
042     * @see com.liferay.portlet.shopping.model.impl.ShoppingCouponModelImpl
043     * @generated
044     */
045    public interface ShoppingCouponModel extends BaseModel<ShoppingCoupon> {
046            /**
047             * Gets the primary key of this shopping coupon.
048             *
049             * @return the primary key of this shopping coupon
050             */
051            public long getPrimaryKey();
052    
053            /**
054             * Sets the primary key of this shopping coupon
055             *
056             * @param pk the primary key of this shopping coupon
057             */
058            public void setPrimaryKey(long pk);
059    
060            /**
061             * Gets the coupon id of this shopping coupon.
062             *
063             * @return the coupon id of this shopping coupon
064             */
065            public long getCouponId();
066    
067            /**
068             * Sets the coupon id of this shopping coupon.
069             *
070             * @param couponId the coupon id of this shopping coupon
071             */
072            public void setCouponId(long couponId);
073    
074            /**
075             * Gets the group id of this shopping coupon.
076             *
077             * @return the group id of this shopping coupon
078             */
079            public long getGroupId();
080    
081            /**
082             * Sets the group id of this shopping coupon.
083             *
084             * @param groupId the group id of this shopping coupon
085             */
086            public void setGroupId(long groupId);
087    
088            /**
089             * Gets the company id of this shopping coupon.
090             *
091             * @return the company id of this shopping coupon
092             */
093            public long getCompanyId();
094    
095            /**
096             * Sets the company id of this shopping coupon.
097             *
098             * @param companyId the company id of this shopping coupon
099             */
100            public void setCompanyId(long companyId);
101    
102            /**
103             * Gets the user id of this shopping coupon.
104             *
105             * @return the user id of this shopping coupon
106             */
107            public long getUserId();
108    
109            /**
110             * Sets the user id of this shopping coupon.
111             *
112             * @param userId the user id of this shopping coupon
113             */
114            public void setUserId(long userId);
115    
116            /**
117             * Gets the user uuid of this shopping coupon.
118             *
119             * @return the user uuid of this shopping coupon
120             * @throws SystemException if a system exception occurred
121             */
122            public String getUserUuid() throws SystemException;
123    
124            /**
125             * Sets the user uuid of this shopping coupon.
126             *
127             * @param userUuid the user uuid of this shopping coupon
128             */
129            public void setUserUuid(String userUuid);
130    
131            /**
132             * Gets the user name of this shopping coupon.
133             *
134             * @return the user name of this shopping coupon
135             */
136            @AutoEscape
137            public String getUserName();
138    
139            /**
140             * Sets the user name of this shopping coupon.
141             *
142             * @param userName the user name of this shopping coupon
143             */
144            public void setUserName(String userName);
145    
146            /**
147             * Gets the create date of this shopping coupon.
148             *
149             * @return the create date of this shopping coupon
150             */
151            public Date getCreateDate();
152    
153            /**
154             * Sets the create date of this shopping coupon.
155             *
156             * @param createDate the create date of this shopping coupon
157             */
158            public void setCreateDate(Date createDate);
159    
160            /**
161             * Gets the modified date of this shopping coupon.
162             *
163             * @return the modified date of this shopping coupon
164             */
165            public Date getModifiedDate();
166    
167            /**
168             * Sets the modified date of this shopping coupon.
169             *
170             * @param modifiedDate the modified date of this shopping coupon
171             */
172            public void setModifiedDate(Date modifiedDate);
173    
174            /**
175             * Gets the code of this shopping coupon.
176             *
177             * @return the code of this shopping coupon
178             */
179            @AutoEscape
180            public String getCode();
181    
182            /**
183             * Sets the code of this shopping coupon.
184             *
185             * @param code the code of this shopping coupon
186             */
187            public void setCode(String code);
188    
189            /**
190             * Gets the name of this shopping coupon.
191             *
192             * @return the name of this shopping coupon
193             */
194            @AutoEscape
195            public String getName();
196    
197            /**
198             * Sets the name of this shopping coupon.
199             *
200             * @param name the name of this shopping coupon
201             */
202            public void setName(String name);
203    
204            /**
205             * Gets the description of this shopping coupon.
206             *
207             * @return the description of this shopping coupon
208             */
209            @AutoEscape
210            public String getDescription();
211    
212            /**
213             * Sets the description of this shopping coupon.
214             *
215             * @param description the description of this shopping coupon
216             */
217            public void setDescription(String description);
218    
219            /**
220             * Gets the start date of this shopping coupon.
221             *
222             * @return the start date of this shopping coupon
223             */
224            public Date getStartDate();
225    
226            /**
227             * Sets the start date of this shopping coupon.
228             *
229             * @param startDate the start date of this shopping coupon
230             */
231            public void setStartDate(Date startDate);
232    
233            /**
234             * Gets the end date of this shopping coupon.
235             *
236             * @return the end date of this shopping coupon
237             */
238            public Date getEndDate();
239    
240            /**
241             * Sets the end date of this shopping coupon.
242             *
243             * @param endDate the end date of this shopping coupon
244             */
245            public void setEndDate(Date endDate);
246    
247            /**
248             * Gets the active of this shopping coupon.
249             *
250             * @return the active of this shopping coupon
251             */
252            public boolean getActive();
253    
254            /**
255             * Determines whether this shopping coupon is active.
256             *
257             * @return whether this shopping coupon is active
258             */
259            public boolean isActive();
260    
261            /**
262             * Sets whether this {$entity.humanName} is active.
263             *
264             * @param active the active of this shopping coupon
265             */
266            public void setActive(boolean active);
267    
268            /**
269             * Gets the limit categories of this shopping coupon.
270             *
271             * @return the limit categories of this shopping coupon
272             */
273            @AutoEscape
274            public String getLimitCategories();
275    
276            /**
277             * Sets the limit categories of this shopping coupon.
278             *
279             * @param limitCategories the limit categories of this shopping coupon
280             */
281            public void setLimitCategories(String limitCategories);
282    
283            /**
284             * Gets the limit skus of this shopping coupon.
285             *
286             * @return the limit skus of this shopping coupon
287             */
288            @AutoEscape
289            public String getLimitSkus();
290    
291            /**
292             * Sets the limit skus of this shopping coupon.
293             *
294             * @param limitSkus the limit skus of this shopping coupon
295             */
296            public void setLimitSkus(String limitSkus);
297    
298            /**
299             * Gets the min order of this shopping coupon.
300             *
301             * @return the min order of this shopping coupon
302             */
303            public double getMinOrder();
304    
305            /**
306             * Sets the min order of this shopping coupon.
307             *
308             * @param minOrder the min order of this shopping coupon
309             */
310            public void setMinOrder(double minOrder);
311    
312            /**
313             * Gets the discount of this shopping coupon.
314             *
315             * @return the discount of this shopping coupon
316             */
317            public double getDiscount();
318    
319            /**
320             * Sets the discount of this shopping coupon.
321             *
322             * @param discount the discount of this shopping coupon
323             */
324            public void setDiscount(double discount);
325    
326            /**
327             * Gets the discount type of this shopping coupon.
328             *
329             * @return the discount type of this shopping coupon
330             */
331            @AutoEscape
332            public String getDiscountType();
333    
334            /**
335             * Sets the discount type of this shopping coupon.
336             *
337             * @param discountType the discount type of this shopping coupon
338             */
339            public void setDiscountType(String discountType);
340    
341            public boolean isNew();
342    
343            public void setNew(boolean n);
344    
345            public boolean isCachedModel();
346    
347            public void setCachedModel(boolean cachedModel);
348    
349            public boolean isEscapedModel();
350    
351            public void setEscapedModel(boolean escapedModel);
352    
353            public Serializable getPrimaryKeyObj();
354    
355            public ExpandoBridge getExpandoBridge();
356    
357            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
358    
359            public Object clone();
360    
361            public int compareTo(ShoppingCoupon shoppingCoupon);
362    
363            public int hashCode();
364    
365            public ShoppingCoupon toEscapedModel();
366    
367            public String toString();
368    
369            public String toXmlString();
370    }