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