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