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