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