001 /** 002 * Copyright (c) 2000-2010 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.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 ShoppingItem service. Represents a row in the "ShoppingItem" 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.ShoppingItemModelImpl} 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.ShoppingItemImpl}. 033 * </p> 034 * 035 * <p> 036 * Never modify or reference this interface directly. All methods that expect a shopping item model instance should use the {@link ShoppingItem} interface instead. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see ShoppingItem 041 * @see com.liferay.portlet.shopping.model.impl.ShoppingItemImpl 042 * @see com.liferay.portlet.shopping.model.impl.ShoppingItemModelImpl 043 * @generated 044 */ 045 public interface ShoppingItemModel extends BaseModel<ShoppingItem> { 046 /** 047 * Gets the primary key of this shopping item. 048 * 049 * @return the primary key of this shopping item 050 */ 051 public long getPrimaryKey(); 052 053 /** 054 * Sets the primary key of this shopping item 055 * 056 * @param pk the primary key of this shopping item 057 */ 058 public void setPrimaryKey(long pk); 059 060 /** 061 * Gets the item id of this shopping item. 062 * 063 * @return the item id of this shopping item 064 */ 065 public long getItemId(); 066 067 /** 068 * Sets the item id of this shopping item. 069 * 070 * @param itemId the item id of this shopping item 071 */ 072 public void setItemId(long itemId); 073 074 /** 075 * Gets the group id of this shopping item. 076 * 077 * @return the group id of this shopping item 078 */ 079 public long getGroupId(); 080 081 /** 082 * Sets the group id of this shopping item. 083 * 084 * @param groupId the group id of this shopping item 085 */ 086 public void setGroupId(long groupId); 087 088 /** 089 * Gets the company id of this shopping item. 090 * 091 * @return the company id of this shopping item 092 */ 093 public long getCompanyId(); 094 095 /** 096 * Sets the company id of this shopping item. 097 * 098 * @param companyId the company id of this shopping item 099 */ 100 public void setCompanyId(long companyId); 101 102 /** 103 * Gets the user id of this shopping item. 104 * 105 * @return the user id of this shopping item 106 */ 107 public long getUserId(); 108 109 /** 110 * Sets the user id of this shopping item. 111 * 112 * @param userId the user id of this shopping item 113 */ 114 public void setUserId(long userId); 115 116 /** 117 * Gets the user uuid of this shopping item. 118 * 119 * @return the user uuid of this shopping item 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 item. 126 * 127 * @param userUuid the user uuid of this shopping item 128 */ 129 public void setUserUuid(String userUuid); 130 131 /** 132 * Gets the user name of this shopping item. 133 * 134 * @return the user name of this shopping item 135 */ 136 @AutoEscape 137 public String getUserName(); 138 139 /** 140 * Sets the user name of this shopping item. 141 * 142 * @param userName the user name of this shopping item 143 */ 144 public void setUserName(String userName); 145 146 /** 147 * Gets the create date of this shopping item. 148 * 149 * @return the create date of this shopping item 150 */ 151 public Date getCreateDate(); 152 153 /** 154 * Sets the create date of this shopping item. 155 * 156 * @param createDate the create date of this shopping item 157 */ 158 public void setCreateDate(Date createDate); 159 160 /** 161 * Gets the modified date of this shopping item. 162 * 163 * @return the modified date of this shopping item 164 */ 165 public Date getModifiedDate(); 166 167 /** 168 * Sets the modified date of this shopping item. 169 * 170 * @param modifiedDate the modified date of this shopping item 171 */ 172 public void setModifiedDate(Date modifiedDate); 173 174 /** 175 * Gets the category id of this shopping item. 176 * 177 * @return the category id of this shopping item 178 */ 179 public long getCategoryId(); 180 181 /** 182 * Sets the category id of this shopping item. 183 * 184 * @param categoryId the category id of this shopping item 185 */ 186 public void setCategoryId(long categoryId); 187 188 /** 189 * Gets the sku of this shopping item. 190 * 191 * @return the sku of this shopping item 192 */ 193 @AutoEscape 194 public String getSku(); 195 196 /** 197 * Sets the sku of this shopping item. 198 * 199 * @param sku the sku of this shopping item 200 */ 201 public void setSku(String sku); 202 203 /** 204 * Gets the name of this shopping item. 205 * 206 * @return the name of this shopping item 207 */ 208 @AutoEscape 209 public String getName(); 210 211 /** 212 * Sets the name of this shopping item. 213 * 214 * @param name the name of this shopping item 215 */ 216 public void setName(String name); 217 218 /** 219 * Gets the description of this shopping item. 220 * 221 * @return the description of this shopping item 222 */ 223 @AutoEscape 224 public String getDescription(); 225 226 /** 227 * Sets the description of this shopping item. 228 * 229 * @param description the description of this shopping item 230 */ 231 public void setDescription(String description); 232 233 /** 234 * Gets the properties of this shopping item. 235 * 236 * @return the properties of this shopping item 237 */ 238 @AutoEscape 239 public String getProperties(); 240 241 /** 242 * Sets the properties of this shopping item. 243 * 244 * @param properties the properties of this shopping item 245 */ 246 public void setProperties(String properties); 247 248 /** 249 * Gets the fields of this shopping item. 250 * 251 * @return the fields of this shopping item 252 */ 253 public boolean getFields(); 254 255 /** 256 * Determines whether this shopping item is fields. 257 * 258 * @return whether this shopping item is fields 259 */ 260 public boolean isFields(); 261 262 /** 263 * Sets whether this {$entity.humanName} is fields. 264 * 265 * @param fields the fields of this shopping item 266 */ 267 public void setFields(boolean fields); 268 269 /** 270 * Gets the fields quantities of this shopping item. 271 * 272 * @return the fields quantities of this shopping item 273 */ 274 @AutoEscape 275 public String getFieldsQuantities(); 276 277 /** 278 * Sets the fields quantities of this shopping item. 279 * 280 * @param fieldsQuantities the fields quantities of this shopping item 281 */ 282 public void setFieldsQuantities(String fieldsQuantities); 283 284 /** 285 * Gets the min quantity of this shopping item. 286 * 287 * @return the min quantity of this shopping item 288 */ 289 public int getMinQuantity(); 290 291 /** 292 * Sets the min quantity of this shopping item. 293 * 294 * @param minQuantity the min quantity of this shopping item 295 */ 296 public void setMinQuantity(int minQuantity); 297 298 /** 299 * Gets the max quantity of this shopping item. 300 * 301 * @return the max quantity of this shopping item 302 */ 303 public int getMaxQuantity(); 304 305 /** 306 * Sets the max quantity of this shopping item. 307 * 308 * @param maxQuantity the max quantity of this shopping item 309 */ 310 public void setMaxQuantity(int maxQuantity); 311 312 /** 313 * Gets the price of this shopping item. 314 * 315 * @return the price of this shopping item 316 */ 317 public double getPrice(); 318 319 /** 320 * Sets the price of this shopping item. 321 * 322 * @param price the price of this shopping item 323 */ 324 public void setPrice(double price); 325 326 /** 327 * Gets the discount of this shopping item. 328 * 329 * @return the discount of this shopping item 330 */ 331 public double getDiscount(); 332 333 /** 334 * Sets the discount of this shopping item. 335 * 336 * @param discount the discount of this shopping item 337 */ 338 public void setDiscount(double discount); 339 340 /** 341 * Gets the taxable of this shopping item. 342 * 343 * @return the taxable of this shopping item 344 */ 345 public boolean getTaxable(); 346 347 /** 348 * Determines whether this shopping item is taxable. 349 * 350 * @return whether this shopping item is taxable 351 */ 352 public boolean isTaxable(); 353 354 /** 355 * Sets whether this {$entity.humanName} is taxable. 356 * 357 * @param taxable the taxable of this shopping item 358 */ 359 public void setTaxable(boolean taxable); 360 361 /** 362 * Gets the shipping of this shopping item. 363 * 364 * @return the shipping of this shopping item 365 */ 366 public double getShipping(); 367 368 /** 369 * Sets the shipping of this shopping item. 370 * 371 * @param shipping the shipping of this shopping item 372 */ 373 public void setShipping(double shipping); 374 375 /** 376 * Gets the use shipping formula of this shopping item. 377 * 378 * @return the use shipping formula of this shopping item 379 */ 380 public boolean getUseShippingFormula(); 381 382 /** 383 * Determines whether this shopping item is use shipping formula. 384 * 385 * @return whether this shopping item is use shipping formula 386 */ 387 public boolean isUseShippingFormula(); 388 389 /** 390 * Sets whether this {$entity.humanName} is use shipping formula. 391 * 392 * @param useShippingFormula the use shipping formula of this shopping item 393 */ 394 public void setUseShippingFormula(boolean useShippingFormula); 395 396 /** 397 * Gets the requires shipping of this shopping item. 398 * 399 * @return the requires shipping of this shopping item 400 */ 401 public boolean getRequiresShipping(); 402 403 /** 404 * Determines whether this shopping item is requires shipping. 405 * 406 * @return whether this shopping item is requires shipping 407 */ 408 public boolean isRequiresShipping(); 409 410 /** 411 * Sets whether this {$entity.humanName} is requires shipping. 412 * 413 * @param requiresShipping the requires shipping of this shopping item 414 */ 415 public void setRequiresShipping(boolean requiresShipping); 416 417 /** 418 * Gets the stock quantity of this shopping item. 419 * 420 * @return the stock quantity of this shopping item 421 */ 422 public int getStockQuantity(); 423 424 /** 425 * Sets the stock quantity of this shopping item. 426 * 427 * @param stockQuantity the stock quantity of this shopping item 428 */ 429 public void setStockQuantity(int stockQuantity); 430 431 /** 432 * Gets the featured of this shopping item. 433 * 434 * @return the featured of this shopping item 435 */ 436 public boolean getFeatured(); 437 438 /** 439 * Determines whether this shopping item is featured. 440 * 441 * @return whether this shopping item is featured 442 */ 443 public boolean isFeatured(); 444 445 /** 446 * Sets whether this {$entity.humanName} is featured. 447 * 448 * @param featured the featured of this shopping item 449 */ 450 public void setFeatured(boolean featured); 451 452 /** 453 * Gets the sale of this shopping item. 454 * 455 * @return the sale of this shopping item 456 */ 457 public boolean getSale(); 458 459 /** 460 * Determines whether this shopping item is sale. 461 * 462 * @return whether this shopping item is sale 463 */ 464 public boolean isSale(); 465 466 /** 467 * Sets whether this {$entity.humanName} is sale. 468 * 469 * @param sale the sale of this shopping item 470 */ 471 public void setSale(boolean sale); 472 473 /** 474 * Gets the small image of this shopping item. 475 * 476 * @return the small image of this shopping item 477 */ 478 public boolean getSmallImage(); 479 480 /** 481 * Determines whether this shopping item is small image. 482 * 483 * @return whether this shopping item is small image 484 */ 485 public boolean isSmallImage(); 486 487 /** 488 * Sets whether this {$entity.humanName} is small image. 489 * 490 * @param smallImage the small image of this shopping item 491 */ 492 public void setSmallImage(boolean smallImage); 493 494 /** 495 * Gets the small image id of this shopping item. 496 * 497 * @return the small image id of this shopping item 498 */ 499 public long getSmallImageId(); 500 501 /** 502 * Sets the small image id of this shopping item. 503 * 504 * @param smallImageId the small image id of this shopping item 505 */ 506 public void setSmallImageId(long smallImageId); 507 508 /** 509 * Gets the small image u r l of this shopping item. 510 * 511 * @return the small image u r l of this shopping item 512 */ 513 @AutoEscape 514 public String getSmallImageURL(); 515 516 /** 517 * Sets the small image u r l of this shopping item. 518 * 519 * @param smallImageURL the small image u r l of this shopping item 520 */ 521 public void setSmallImageURL(String smallImageURL); 522 523 /** 524 * Gets the medium image of this shopping item. 525 * 526 * @return the medium image of this shopping item 527 */ 528 public boolean getMediumImage(); 529 530 /** 531 * Determines whether this shopping item is medium image. 532 * 533 * @return whether this shopping item is medium image 534 */ 535 public boolean isMediumImage(); 536 537 /** 538 * Sets whether this {$entity.humanName} is medium image. 539 * 540 * @param mediumImage the medium image of this shopping item 541 */ 542 public void setMediumImage(boolean mediumImage); 543 544 /** 545 * Gets the medium image id of this shopping item. 546 * 547 * @return the medium image id of this shopping item 548 */ 549 public long getMediumImageId(); 550 551 /** 552 * Sets the medium image id of this shopping item. 553 * 554 * @param mediumImageId the medium image id of this shopping item 555 */ 556 public void setMediumImageId(long mediumImageId); 557 558 /** 559 * Gets the medium image u r l of this shopping item. 560 * 561 * @return the medium image u r l of this shopping item 562 */ 563 @AutoEscape 564 public String getMediumImageURL(); 565 566 /** 567 * Sets the medium image u r l of this shopping item. 568 * 569 * @param mediumImageURL the medium image u r l of this shopping item 570 */ 571 public void setMediumImageURL(String mediumImageURL); 572 573 /** 574 * Gets the large image of this shopping item. 575 * 576 * @return the large image of this shopping item 577 */ 578 public boolean getLargeImage(); 579 580 /** 581 * Determines whether this shopping item is large image. 582 * 583 * @return whether this shopping item is large image 584 */ 585 public boolean isLargeImage(); 586 587 /** 588 * Sets whether this {$entity.humanName} is large image. 589 * 590 * @param largeImage the large image of this shopping item 591 */ 592 public void setLargeImage(boolean largeImage); 593 594 /** 595 * Gets the large image id of this shopping item. 596 * 597 * @return the large image id of this shopping item 598 */ 599 public long getLargeImageId(); 600 601 /** 602 * Sets the large image id of this shopping item. 603 * 604 * @param largeImageId the large image id of this shopping item 605 */ 606 public void setLargeImageId(long largeImageId); 607 608 /** 609 * Gets the large image u r l of this shopping item. 610 * 611 * @return the large image u r l of this shopping item 612 */ 613 @AutoEscape 614 public String getLargeImageURL(); 615 616 /** 617 * Sets the large image u r l of this shopping item. 618 * 619 * @param largeImageURL the large image u r l of this shopping item 620 */ 621 public void setLargeImageURL(String largeImageURL); 622 623 /** 624 * Gets a copy of this shopping item as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 625 * 626 * @return the escaped model instance 627 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 628 */ 629 public ShoppingItem toEscapedModel(); 630 631 public boolean isNew(); 632 633 public void setNew(boolean n); 634 635 public boolean isCachedModel(); 636 637 public void setCachedModel(boolean cachedModel); 638 639 public boolean isEscapedModel(); 640 641 public void setEscapedModel(boolean escapedModel); 642 643 public Serializable getPrimaryKeyObj(); 644 645 public ExpandoBridge getExpandoBridge(); 646 647 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 648 649 public Object clone(); 650 651 public int compareTo(ShoppingItem shoppingItem); 652 653 public int hashCode(); 654 655 public String toString(); 656 657 public String toXmlString(); 658 }