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