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