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