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