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