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 @Override 085 public long getGroupId(); 086 087 /** 088 * Sets the group ID of this shopping coupon. 089 * 090 * @param groupId the group ID of this shopping coupon 091 */ 092 @Override 093 public void setGroupId(long groupId); 094 095 /** 096 * Returns the company ID of this shopping coupon. 097 * 098 * @return the company ID of this shopping coupon 099 */ 100 @Override 101 public long getCompanyId(); 102 103 /** 104 * Sets the company ID of this shopping coupon. 105 * 106 * @param companyId the company ID of this shopping coupon 107 */ 108 @Override 109 public void setCompanyId(long companyId); 110 111 /** 112 * Returns the user ID of this shopping coupon. 113 * 114 * @return the user ID of this shopping coupon 115 */ 116 @Override 117 public long getUserId(); 118 119 /** 120 * Sets the user ID of this shopping coupon. 121 * 122 * @param userId the user ID of this shopping coupon 123 */ 124 @Override 125 public void setUserId(long userId); 126 127 /** 128 * Returns the user uuid of this shopping coupon. 129 * 130 * @return the user uuid of this shopping coupon 131 * @throws SystemException if a system exception occurred 132 */ 133 @Override 134 public String getUserUuid() throws SystemException; 135 136 /** 137 * Sets the user uuid of this shopping coupon. 138 * 139 * @param userUuid the user uuid of this shopping coupon 140 */ 141 @Override 142 public void setUserUuid(String userUuid); 143 144 /** 145 * Returns the user name of this shopping coupon. 146 * 147 * @return the user name of this shopping coupon 148 */ 149 @AutoEscape 150 @Override 151 public String getUserName(); 152 153 /** 154 * Sets the user name of this shopping coupon. 155 * 156 * @param userName the user name of this shopping coupon 157 */ 158 @Override 159 public void setUserName(String userName); 160 161 /** 162 * Returns the create date of this shopping coupon. 163 * 164 * @return the create date of this shopping coupon 165 */ 166 @Override 167 public Date getCreateDate(); 168 169 /** 170 * Sets the create date of this shopping coupon. 171 * 172 * @param createDate the create date of this shopping coupon 173 */ 174 @Override 175 public void setCreateDate(Date createDate); 176 177 /** 178 * Returns the modified date of this shopping coupon. 179 * 180 * @return the modified date of this shopping coupon 181 */ 182 @Override 183 public Date getModifiedDate(); 184 185 /** 186 * Sets the modified date of this shopping coupon. 187 * 188 * @param modifiedDate the modified date of this shopping coupon 189 */ 190 @Override 191 public void setModifiedDate(Date modifiedDate); 192 193 /** 194 * Returns the code of this shopping coupon. 195 * 196 * @return the code of this shopping coupon 197 */ 198 @AutoEscape 199 public String getCode(); 200 201 /** 202 * Sets the code of this shopping coupon. 203 * 204 * @param code the code of this shopping coupon 205 */ 206 public void setCode(String code); 207 208 /** 209 * Returns the name of this shopping coupon. 210 * 211 * @return the name of this shopping coupon 212 */ 213 @AutoEscape 214 public String getName(); 215 216 /** 217 * Sets the name of this shopping coupon. 218 * 219 * @param name the name of this shopping coupon 220 */ 221 public void setName(String name); 222 223 /** 224 * Returns the description of this shopping coupon. 225 * 226 * @return the description of this shopping coupon 227 */ 228 @AutoEscape 229 public String getDescription(); 230 231 /** 232 * Sets the description of this shopping coupon. 233 * 234 * @param description the description of this shopping coupon 235 */ 236 public void setDescription(String description); 237 238 /** 239 * Returns the start date of this shopping coupon. 240 * 241 * @return the start date of this shopping coupon 242 */ 243 public Date getStartDate(); 244 245 /** 246 * Sets the start date of this shopping coupon. 247 * 248 * @param startDate the start date of this shopping coupon 249 */ 250 public void setStartDate(Date startDate); 251 252 /** 253 * Returns the end date of this shopping coupon. 254 * 255 * @return the end date of this shopping coupon 256 */ 257 public Date getEndDate(); 258 259 /** 260 * Sets the end date of this shopping coupon. 261 * 262 * @param endDate the end date of this shopping coupon 263 */ 264 public void setEndDate(Date endDate); 265 266 /** 267 * Returns the active of this shopping coupon. 268 * 269 * @return the active of this shopping coupon 270 */ 271 public boolean getActive(); 272 273 /** 274 * Returns <code>true</code> if this shopping coupon is active. 275 * 276 * @return <code>true</code> if this shopping coupon is active; <code>false</code> otherwise 277 */ 278 public boolean isActive(); 279 280 /** 281 * Sets whether this shopping coupon is active. 282 * 283 * @param active the active of this shopping coupon 284 */ 285 public void setActive(boolean active); 286 287 /** 288 * Returns the limit categories of this shopping coupon. 289 * 290 * @return the limit categories of this shopping coupon 291 */ 292 @AutoEscape 293 public String getLimitCategories(); 294 295 /** 296 * Sets the limit categories of this shopping coupon. 297 * 298 * @param limitCategories the limit categories of this shopping coupon 299 */ 300 public void setLimitCategories(String limitCategories); 301 302 /** 303 * Returns the limit skus of this shopping coupon. 304 * 305 * @return the limit skus of this shopping coupon 306 */ 307 @AutoEscape 308 public String getLimitSkus(); 309 310 /** 311 * Sets the limit skus of this shopping coupon. 312 * 313 * @param limitSkus the limit skus of this shopping coupon 314 */ 315 public void setLimitSkus(String limitSkus); 316 317 /** 318 * Returns the min order of this shopping coupon. 319 * 320 * @return the min order of this shopping coupon 321 */ 322 public double getMinOrder(); 323 324 /** 325 * Sets the min order of this shopping coupon. 326 * 327 * @param minOrder the min order of this shopping coupon 328 */ 329 public void setMinOrder(double minOrder); 330 331 /** 332 * Returns the discount of this shopping coupon. 333 * 334 * @return the discount of this shopping coupon 335 */ 336 public double getDiscount(); 337 338 /** 339 * Sets the discount of this shopping coupon. 340 * 341 * @param discount the discount of this shopping coupon 342 */ 343 public void setDiscount(double discount); 344 345 /** 346 * Returns the discount type of this shopping coupon. 347 * 348 * @return the discount type of this shopping coupon 349 */ 350 @AutoEscape 351 public String getDiscountType(); 352 353 /** 354 * Sets the discount type of this shopping coupon. 355 * 356 * @param discountType the discount type of this shopping coupon 357 */ 358 public void setDiscountType(String discountType); 359 360 @Override 361 public boolean isNew(); 362 363 @Override 364 public void setNew(boolean n); 365 366 @Override 367 public boolean isCachedModel(); 368 369 @Override 370 public void setCachedModel(boolean cachedModel); 371 372 @Override 373 public boolean isEscapedModel(); 374 375 @Override 376 public Serializable getPrimaryKeyObj(); 377 378 @Override 379 public void setPrimaryKeyObj(Serializable primaryKeyObj); 380 381 @Override 382 public ExpandoBridge getExpandoBridge(); 383 384 @Override 385 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 386 387 @Override 388 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 389 390 @Override 391 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 392 393 @Override 394 public Object clone(); 395 396 @Override 397 public int compareTo(ShoppingCoupon shoppingCoupon); 398 399 @Override 400 public int hashCode(); 401 402 @Override 403 public CacheModel<ShoppingCoupon> toCacheModel(); 404 405 @Override 406 public ShoppingCoupon toEscapedModel(); 407 408 @Override 409 public ShoppingCoupon toUnescapedModel(); 410 411 @Override 412 public String toString(); 413 414 @Override 415 public String toXmlString(); 416 }