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 ShoppingOrder service. Represents a row in the "ShoppingOrder" 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.ShoppingOrderModelImpl} 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.ShoppingOrderImpl}. 035 * </p> 036 * 037 * @author Brian Wing Shun Chan 038 * @see ShoppingOrder 039 * @see com.liferay.portlet.shopping.model.impl.ShoppingOrderImpl 040 * @see com.liferay.portlet.shopping.model.impl.ShoppingOrderModelImpl 041 * @generated 042 */ 043 public interface ShoppingOrderModel extends BaseModel<ShoppingOrder>, 044 GroupedModel { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. All methods that expect a shopping order model instance should use the {@link ShoppingOrder} interface instead. 049 */ 050 051 /** 052 * Returns the primary key of this shopping order. 053 * 054 * @return the primary key of this shopping order 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this shopping order. 060 * 061 * @param primaryKey the primary key of this shopping order 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the order ID of this shopping order. 067 * 068 * @return the order ID of this shopping order 069 */ 070 public long getOrderId(); 071 072 /** 073 * Sets the order ID of this shopping order. 074 * 075 * @param orderId the order ID of this shopping order 076 */ 077 public void setOrderId(long orderId); 078 079 /** 080 * Returns the group ID of this shopping order. 081 * 082 * @return the group ID of this shopping order 083 */ 084 public long getGroupId(); 085 086 /** 087 * Sets the group ID of this shopping order. 088 * 089 * @param groupId the group ID of this shopping order 090 */ 091 public void setGroupId(long groupId); 092 093 /** 094 * Returns the company ID of this shopping order. 095 * 096 * @return the company ID of this shopping order 097 */ 098 public long getCompanyId(); 099 100 /** 101 * Sets the company ID of this shopping order. 102 * 103 * @param companyId the company ID of this shopping order 104 */ 105 public void setCompanyId(long companyId); 106 107 /** 108 * Returns the user ID of this shopping order. 109 * 110 * @return the user ID of this shopping order 111 */ 112 public long getUserId(); 113 114 /** 115 * Sets the user ID of this shopping order. 116 * 117 * @param userId the user ID of this shopping order 118 */ 119 public void setUserId(long userId); 120 121 /** 122 * Returns the user uuid of this shopping order. 123 * 124 * @return the user uuid of this shopping order 125 * @throws SystemException if a system exception occurred 126 */ 127 public String getUserUuid() throws SystemException; 128 129 /** 130 * Sets the user uuid of this shopping order. 131 * 132 * @param userUuid the user uuid of this shopping order 133 */ 134 public void setUserUuid(String userUuid); 135 136 /** 137 * Returns the user name of this shopping order. 138 * 139 * @return the user name of this shopping order 140 */ 141 @AutoEscape 142 public String getUserName(); 143 144 /** 145 * Sets the user name of this shopping order. 146 * 147 * @param userName the user name of this shopping order 148 */ 149 public void setUserName(String userName); 150 151 /** 152 * Returns the create date of this shopping order. 153 * 154 * @return the create date of this shopping order 155 */ 156 public Date getCreateDate(); 157 158 /** 159 * Sets the create date of this shopping order. 160 * 161 * @param createDate the create date of this shopping order 162 */ 163 public void setCreateDate(Date createDate); 164 165 /** 166 * Returns the modified date of this shopping order. 167 * 168 * @return the modified date of this shopping order 169 */ 170 public Date getModifiedDate(); 171 172 /** 173 * Sets the modified date of this shopping order. 174 * 175 * @param modifiedDate the modified date of this shopping order 176 */ 177 public void setModifiedDate(Date modifiedDate); 178 179 /** 180 * Returns the number of this shopping order. 181 * 182 * @return the number of this shopping order 183 */ 184 @AutoEscape 185 public String getNumber(); 186 187 /** 188 * Sets the number of this shopping order. 189 * 190 * @param number the number of this shopping order 191 */ 192 public void setNumber(String number); 193 194 /** 195 * Returns the tax of this shopping order. 196 * 197 * @return the tax of this shopping order 198 */ 199 public double getTax(); 200 201 /** 202 * Sets the tax of this shopping order. 203 * 204 * @param tax the tax of this shopping order 205 */ 206 public void setTax(double tax); 207 208 /** 209 * Returns the shipping of this shopping order. 210 * 211 * @return the shipping of this shopping order 212 */ 213 public double getShipping(); 214 215 /** 216 * Sets the shipping of this shopping order. 217 * 218 * @param shipping the shipping of this shopping order 219 */ 220 public void setShipping(double shipping); 221 222 /** 223 * Returns the alt shipping of this shopping order. 224 * 225 * @return the alt shipping of this shopping order 226 */ 227 @AutoEscape 228 public String getAltShipping(); 229 230 /** 231 * Sets the alt shipping of this shopping order. 232 * 233 * @param altShipping the alt shipping of this shopping order 234 */ 235 public void setAltShipping(String altShipping); 236 237 /** 238 * Returns the requires shipping of this shopping order. 239 * 240 * @return the requires shipping of this shopping order 241 */ 242 public boolean getRequiresShipping(); 243 244 /** 245 * Returns <code>true</code> if this shopping order is requires shipping. 246 * 247 * @return <code>true</code> if this shopping order is requires shipping; <code>false</code> otherwise 248 */ 249 public boolean isRequiresShipping(); 250 251 /** 252 * Sets whether this shopping order is requires shipping. 253 * 254 * @param requiresShipping the requires shipping of this shopping order 255 */ 256 public void setRequiresShipping(boolean requiresShipping); 257 258 /** 259 * Returns the insure of this shopping order. 260 * 261 * @return the insure of this shopping order 262 */ 263 public boolean getInsure(); 264 265 /** 266 * Returns <code>true</code> if this shopping order is insure. 267 * 268 * @return <code>true</code> if this shopping order is insure; <code>false</code> otherwise 269 */ 270 public boolean isInsure(); 271 272 /** 273 * Sets whether this shopping order is insure. 274 * 275 * @param insure the insure of this shopping order 276 */ 277 public void setInsure(boolean insure); 278 279 /** 280 * Returns the insurance of this shopping order. 281 * 282 * @return the insurance of this shopping order 283 */ 284 public double getInsurance(); 285 286 /** 287 * Sets the insurance of this shopping order. 288 * 289 * @param insurance the insurance of this shopping order 290 */ 291 public void setInsurance(double insurance); 292 293 /** 294 * Returns the coupon codes of this shopping order. 295 * 296 * @return the coupon codes of this shopping order 297 */ 298 @AutoEscape 299 public String getCouponCodes(); 300 301 /** 302 * Sets the coupon codes of this shopping order. 303 * 304 * @param couponCodes the coupon codes of this shopping order 305 */ 306 public void setCouponCodes(String couponCodes); 307 308 /** 309 * Returns the coupon discount of this shopping order. 310 * 311 * @return the coupon discount of this shopping order 312 */ 313 public double getCouponDiscount(); 314 315 /** 316 * Sets the coupon discount of this shopping order. 317 * 318 * @param couponDiscount the coupon discount of this shopping order 319 */ 320 public void setCouponDiscount(double couponDiscount); 321 322 /** 323 * Returns the billing first name of this shopping order. 324 * 325 * @return the billing first name of this shopping order 326 */ 327 @AutoEscape 328 public String getBillingFirstName(); 329 330 /** 331 * Sets the billing first name of this shopping order. 332 * 333 * @param billingFirstName the billing first name of this shopping order 334 */ 335 public void setBillingFirstName(String billingFirstName); 336 337 /** 338 * Returns the billing last name of this shopping order. 339 * 340 * @return the billing last name of this shopping order 341 */ 342 @AutoEscape 343 public String getBillingLastName(); 344 345 /** 346 * Sets the billing last name of this shopping order. 347 * 348 * @param billingLastName the billing last name of this shopping order 349 */ 350 public void setBillingLastName(String billingLastName); 351 352 /** 353 * Returns the billing email address of this shopping order. 354 * 355 * @return the billing email address of this shopping order 356 */ 357 @AutoEscape 358 public String getBillingEmailAddress(); 359 360 /** 361 * Sets the billing email address of this shopping order. 362 * 363 * @param billingEmailAddress the billing email address of this shopping order 364 */ 365 public void setBillingEmailAddress(String billingEmailAddress); 366 367 /** 368 * Returns the billing company of this shopping order. 369 * 370 * @return the billing company of this shopping order 371 */ 372 @AutoEscape 373 public String getBillingCompany(); 374 375 /** 376 * Sets the billing company of this shopping order. 377 * 378 * @param billingCompany the billing company of this shopping order 379 */ 380 public void setBillingCompany(String billingCompany); 381 382 /** 383 * Returns the billing street of this shopping order. 384 * 385 * @return the billing street of this shopping order 386 */ 387 @AutoEscape 388 public String getBillingStreet(); 389 390 /** 391 * Sets the billing street of this shopping order. 392 * 393 * @param billingStreet the billing street of this shopping order 394 */ 395 public void setBillingStreet(String billingStreet); 396 397 /** 398 * Returns the billing city of this shopping order. 399 * 400 * @return the billing city of this shopping order 401 */ 402 @AutoEscape 403 public String getBillingCity(); 404 405 /** 406 * Sets the billing city of this shopping order. 407 * 408 * @param billingCity the billing city of this shopping order 409 */ 410 public void setBillingCity(String billingCity); 411 412 /** 413 * Returns the billing state of this shopping order. 414 * 415 * @return the billing state of this shopping order 416 */ 417 @AutoEscape 418 public String getBillingState(); 419 420 /** 421 * Sets the billing state of this shopping order. 422 * 423 * @param billingState the billing state of this shopping order 424 */ 425 public void setBillingState(String billingState); 426 427 /** 428 * Returns the billing zip of this shopping order. 429 * 430 * @return the billing zip of this shopping order 431 */ 432 @AutoEscape 433 public String getBillingZip(); 434 435 /** 436 * Sets the billing zip of this shopping order. 437 * 438 * @param billingZip the billing zip of this shopping order 439 */ 440 public void setBillingZip(String billingZip); 441 442 /** 443 * Returns the billing country of this shopping order. 444 * 445 * @return the billing country of this shopping order 446 */ 447 @AutoEscape 448 public String getBillingCountry(); 449 450 /** 451 * Sets the billing country of this shopping order. 452 * 453 * @param billingCountry the billing country of this shopping order 454 */ 455 public void setBillingCountry(String billingCountry); 456 457 /** 458 * Returns the billing phone of this shopping order. 459 * 460 * @return the billing phone of this shopping order 461 */ 462 @AutoEscape 463 public String getBillingPhone(); 464 465 /** 466 * Sets the billing phone of this shopping order. 467 * 468 * @param billingPhone the billing phone of this shopping order 469 */ 470 public void setBillingPhone(String billingPhone); 471 472 /** 473 * Returns the ship to billing of this shopping order. 474 * 475 * @return the ship to billing of this shopping order 476 */ 477 public boolean getShipToBilling(); 478 479 /** 480 * Returns <code>true</code> if this shopping order is ship to billing. 481 * 482 * @return <code>true</code> if this shopping order is ship to billing; <code>false</code> otherwise 483 */ 484 public boolean isShipToBilling(); 485 486 /** 487 * Sets whether this shopping order is ship to billing. 488 * 489 * @param shipToBilling the ship to billing of this shopping order 490 */ 491 public void setShipToBilling(boolean shipToBilling); 492 493 /** 494 * Returns the shipping first name of this shopping order. 495 * 496 * @return the shipping first name of this shopping order 497 */ 498 @AutoEscape 499 public String getShippingFirstName(); 500 501 /** 502 * Sets the shipping first name of this shopping order. 503 * 504 * @param shippingFirstName the shipping first name of this shopping order 505 */ 506 public void setShippingFirstName(String shippingFirstName); 507 508 /** 509 * Returns the shipping last name of this shopping order. 510 * 511 * @return the shipping last name of this shopping order 512 */ 513 @AutoEscape 514 public String getShippingLastName(); 515 516 /** 517 * Sets the shipping last name of this shopping order. 518 * 519 * @param shippingLastName the shipping last name of this shopping order 520 */ 521 public void setShippingLastName(String shippingLastName); 522 523 /** 524 * Returns the shipping email address of this shopping order. 525 * 526 * @return the shipping email address of this shopping order 527 */ 528 @AutoEscape 529 public String getShippingEmailAddress(); 530 531 /** 532 * Sets the shipping email address of this shopping order. 533 * 534 * @param shippingEmailAddress the shipping email address of this shopping order 535 */ 536 public void setShippingEmailAddress(String shippingEmailAddress); 537 538 /** 539 * Returns the shipping company of this shopping order. 540 * 541 * @return the shipping company of this shopping order 542 */ 543 @AutoEscape 544 public String getShippingCompany(); 545 546 /** 547 * Sets the shipping company of this shopping order. 548 * 549 * @param shippingCompany the shipping company of this shopping order 550 */ 551 public void setShippingCompany(String shippingCompany); 552 553 /** 554 * Returns the shipping street of this shopping order. 555 * 556 * @return the shipping street of this shopping order 557 */ 558 @AutoEscape 559 public String getShippingStreet(); 560 561 /** 562 * Sets the shipping street of this shopping order. 563 * 564 * @param shippingStreet the shipping street of this shopping order 565 */ 566 public void setShippingStreet(String shippingStreet); 567 568 /** 569 * Returns the shipping city of this shopping order. 570 * 571 * @return the shipping city of this shopping order 572 */ 573 @AutoEscape 574 public String getShippingCity(); 575 576 /** 577 * Sets the shipping city of this shopping order. 578 * 579 * @param shippingCity the shipping city of this shopping order 580 */ 581 public void setShippingCity(String shippingCity); 582 583 /** 584 * Returns the shipping state of this shopping order. 585 * 586 * @return the shipping state of this shopping order 587 */ 588 @AutoEscape 589 public String getShippingState(); 590 591 /** 592 * Sets the shipping state of this shopping order. 593 * 594 * @param shippingState the shipping state of this shopping order 595 */ 596 public void setShippingState(String shippingState); 597 598 /** 599 * Returns the shipping zip of this shopping order. 600 * 601 * @return the shipping zip of this shopping order 602 */ 603 @AutoEscape 604 public String getShippingZip(); 605 606 /** 607 * Sets the shipping zip of this shopping order. 608 * 609 * @param shippingZip the shipping zip of this shopping order 610 */ 611 public void setShippingZip(String shippingZip); 612 613 /** 614 * Returns the shipping country of this shopping order. 615 * 616 * @return the shipping country of this shopping order 617 */ 618 @AutoEscape 619 public String getShippingCountry(); 620 621 /** 622 * Sets the shipping country of this shopping order. 623 * 624 * @param shippingCountry the shipping country of this shopping order 625 */ 626 public void setShippingCountry(String shippingCountry); 627 628 /** 629 * Returns the shipping phone of this shopping order. 630 * 631 * @return the shipping phone of this shopping order 632 */ 633 @AutoEscape 634 public String getShippingPhone(); 635 636 /** 637 * Sets the shipping phone of this shopping order. 638 * 639 * @param shippingPhone the shipping phone of this shopping order 640 */ 641 public void setShippingPhone(String shippingPhone); 642 643 /** 644 * Returns the cc name of this shopping order. 645 * 646 * @return the cc name of this shopping order 647 */ 648 @AutoEscape 649 public String getCcName(); 650 651 /** 652 * Sets the cc name of this shopping order. 653 * 654 * @param ccName the cc name of this shopping order 655 */ 656 public void setCcName(String ccName); 657 658 /** 659 * Returns the cc type of this shopping order. 660 * 661 * @return the cc type of this shopping order 662 */ 663 @AutoEscape 664 public String getCcType(); 665 666 /** 667 * Sets the cc type of this shopping order. 668 * 669 * @param ccType the cc type of this shopping order 670 */ 671 public void setCcType(String ccType); 672 673 /** 674 * Returns the cc number of this shopping order. 675 * 676 * @return the cc number of this shopping order 677 */ 678 @AutoEscape 679 public String getCcNumber(); 680 681 /** 682 * Sets the cc number of this shopping order. 683 * 684 * @param ccNumber the cc number of this shopping order 685 */ 686 public void setCcNumber(String ccNumber); 687 688 /** 689 * Returns the cc exp month of this shopping order. 690 * 691 * @return the cc exp month of this shopping order 692 */ 693 public int getCcExpMonth(); 694 695 /** 696 * Sets the cc exp month of this shopping order. 697 * 698 * @param ccExpMonth the cc exp month of this shopping order 699 */ 700 public void setCcExpMonth(int ccExpMonth); 701 702 /** 703 * Returns the cc exp year of this shopping order. 704 * 705 * @return the cc exp year of this shopping order 706 */ 707 public int getCcExpYear(); 708 709 /** 710 * Sets the cc exp year of this shopping order. 711 * 712 * @param ccExpYear the cc exp year of this shopping order 713 */ 714 public void setCcExpYear(int ccExpYear); 715 716 /** 717 * Returns the cc ver number of this shopping order. 718 * 719 * @return the cc ver number of this shopping order 720 */ 721 @AutoEscape 722 public String getCcVerNumber(); 723 724 /** 725 * Sets the cc ver number of this shopping order. 726 * 727 * @param ccVerNumber the cc ver number of this shopping order 728 */ 729 public void setCcVerNumber(String ccVerNumber); 730 731 /** 732 * Returns the comments of this shopping order. 733 * 734 * @return the comments of this shopping order 735 */ 736 @AutoEscape 737 public String getComments(); 738 739 /** 740 * Sets the comments of this shopping order. 741 * 742 * @param comments the comments of this shopping order 743 */ 744 public void setComments(String comments); 745 746 /** 747 * Returns the pp txn ID of this shopping order. 748 * 749 * @return the pp txn ID of this shopping order 750 */ 751 @AutoEscape 752 public String getPpTxnId(); 753 754 /** 755 * Sets the pp txn ID of this shopping order. 756 * 757 * @param ppTxnId the pp txn ID of this shopping order 758 */ 759 public void setPpTxnId(String ppTxnId); 760 761 /** 762 * Returns the pp payment status of this shopping order. 763 * 764 * @return the pp payment status of this shopping order 765 */ 766 @AutoEscape 767 public String getPpPaymentStatus(); 768 769 /** 770 * Sets the pp payment status of this shopping order. 771 * 772 * @param ppPaymentStatus the pp payment status of this shopping order 773 */ 774 public void setPpPaymentStatus(String ppPaymentStatus); 775 776 /** 777 * Returns the pp payment gross of this shopping order. 778 * 779 * @return the pp payment gross of this shopping order 780 */ 781 public double getPpPaymentGross(); 782 783 /** 784 * Sets the pp payment gross of this shopping order. 785 * 786 * @param ppPaymentGross the pp payment gross of this shopping order 787 */ 788 public void setPpPaymentGross(double ppPaymentGross); 789 790 /** 791 * Returns the pp receiver email of this shopping order. 792 * 793 * @return the pp receiver email of this shopping order 794 */ 795 @AutoEscape 796 public String getPpReceiverEmail(); 797 798 /** 799 * Sets the pp receiver email of this shopping order. 800 * 801 * @param ppReceiverEmail the pp receiver email of this shopping order 802 */ 803 public void setPpReceiverEmail(String ppReceiverEmail); 804 805 /** 806 * Returns the pp payer email of this shopping order. 807 * 808 * @return the pp payer email of this shopping order 809 */ 810 @AutoEscape 811 public String getPpPayerEmail(); 812 813 /** 814 * Sets the pp payer email of this shopping order. 815 * 816 * @param ppPayerEmail the pp payer email of this shopping order 817 */ 818 public void setPpPayerEmail(String ppPayerEmail); 819 820 /** 821 * Returns the send order email of this shopping order. 822 * 823 * @return the send order email of this shopping order 824 */ 825 public boolean getSendOrderEmail(); 826 827 /** 828 * Returns <code>true</code> if this shopping order is send order email. 829 * 830 * @return <code>true</code> if this shopping order is send order email; <code>false</code> otherwise 831 */ 832 public boolean isSendOrderEmail(); 833 834 /** 835 * Sets whether this shopping order is send order email. 836 * 837 * @param sendOrderEmail the send order email of this shopping order 838 */ 839 public void setSendOrderEmail(boolean sendOrderEmail); 840 841 /** 842 * Returns the send shipping email of this shopping order. 843 * 844 * @return the send shipping email of this shopping order 845 */ 846 public boolean getSendShippingEmail(); 847 848 /** 849 * Returns <code>true</code> if this shopping order is send shipping email. 850 * 851 * @return <code>true</code> if this shopping order is send shipping email; <code>false</code> otherwise 852 */ 853 public boolean isSendShippingEmail(); 854 855 /** 856 * Sets whether this shopping order is send shipping email. 857 * 858 * @param sendShippingEmail the send shipping email of this shopping order 859 */ 860 public void setSendShippingEmail(boolean sendShippingEmail); 861 862 public boolean isNew(); 863 864 public void setNew(boolean n); 865 866 public boolean isCachedModel(); 867 868 public void setCachedModel(boolean cachedModel); 869 870 public boolean isEscapedModel(); 871 872 public Serializable getPrimaryKeyObj(); 873 874 public void setPrimaryKeyObj(Serializable primaryKeyObj); 875 876 public ExpandoBridge getExpandoBridge(); 877 878 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 879 880 public Object clone(); 881 882 public int compareTo(ShoppingOrder shoppingOrder); 883 884 public int hashCode(); 885 886 public CacheModel<ShoppingOrder> toCacheModel(); 887 888 public ShoppingOrder toEscapedModel(); 889 890 public ShoppingOrder toUnescapedModel(); 891 892 public String toString(); 893 894 public String toXmlString(); 895 }