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 ShoppingCategory service. Represents a row in the "ShoppingCategory" 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.ShoppingCategoryModelImpl} 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.ShoppingCategoryImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see ShoppingCategory
039     * @see com.liferay.portlet.shopping.model.impl.ShoppingCategoryImpl
040     * @see com.liferay.portlet.shopping.model.impl.ShoppingCategoryModelImpl
041     * @generated
042     */
043    public interface ShoppingCategoryModel extends BaseModel<ShoppingCategory>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a shopping category model instance should use the {@link ShoppingCategory} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this shopping category.
053             *
054             * @return the primary key of this shopping category
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this shopping category.
060             *
061             * @param primaryKey the primary key of this shopping category
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the category ID of this shopping category.
067             *
068             * @return the category ID of this shopping category
069             */
070            public long getCategoryId();
071    
072            /**
073             * Sets the category ID of this shopping category.
074             *
075             * @param categoryId the category ID of this shopping category
076             */
077            public void setCategoryId(long categoryId);
078    
079            /**
080             * Returns the group ID of this shopping category.
081             *
082             * @return the group ID of this shopping category
083             */
084            public long getGroupId();
085    
086            /**
087             * Sets the group ID of this shopping category.
088             *
089             * @param groupId the group ID of this shopping category
090             */
091            public void setGroupId(long groupId);
092    
093            /**
094             * Returns the company ID of this shopping category.
095             *
096             * @return the company ID of this shopping category
097             */
098            public long getCompanyId();
099    
100            /**
101             * Sets the company ID of this shopping category.
102             *
103             * @param companyId the company ID of this shopping category
104             */
105            public void setCompanyId(long companyId);
106    
107            /**
108             * Returns the user ID of this shopping category.
109             *
110             * @return the user ID of this shopping category
111             */
112            public long getUserId();
113    
114            /**
115             * Sets the user ID of this shopping category.
116             *
117             * @param userId the user ID of this shopping category
118             */
119            public void setUserId(long userId);
120    
121            /**
122             * Returns the user uuid of this shopping category.
123             *
124             * @return the user uuid of this shopping category
125             * @throws SystemException if a system exception occurred
126             */
127            public String getUserUuid() throws SystemException;
128    
129            /**
130             * Sets the user uuid of this shopping category.
131             *
132             * @param userUuid the user uuid of this shopping category
133             */
134            public void setUserUuid(String userUuid);
135    
136            /**
137             * Returns the user name of this shopping category.
138             *
139             * @return the user name of this shopping category
140             */
141            @AutoEscape
142            public String getUserName();
143    
144            /**
145             * Sets the user name of this shopping category.
146             *
147             * @param userName the user name of this shopping category
148             */
149            public void setUserName(String userName);
150    
151            /**
152             * Returns the create date of this shopping category.
153             *
154             * @return the create date of this shopping category
155             */
156            public Date getCreateDate();
157    
158            /**
159             * Sets the create date of this shopping category.
160             *
161             * @param createDate the create date of this shopping category
162             */
163            public void setCreateDate(Date createDate);
164    
165            /**
166             * Returns the modified date of this shopping category.
167             *
168             * @return the modified date of this shopping category
169             */
170            public Date getModifiedDate();
171    
172            /**
173             * Sets the modified date of this shopping category.
174             *
175             * @param modifiedDate the modified date of this shopping category
176             */
177            public void setModifiedDate(Date modifiedDate);
178    
179            /**
180             * Returns the parent category ID of this shopping category.
181             *
182             * @return the parent category ID of this shopping category
183             */
184            public long getParentCategoryId();
185    
186            /**
187             * Sets the parent category ID of this shopping category.
188             *
189             * @param parentCategoryId the parent category ID of this shopping category
190             */
191            public void setParentCategoryId(long parentCategoryId);
192    
193            /**
194             * Returns the name of this shopping category.
195             *
196             * @return the name of this shopping category
197             */
198            @AutoEscape
199            public String getName();
200    
201            /**
202             * Sets the name of this shopping category.
203             *
204             * @param name the name of this shopping category
205             */
206            public void setName(String name);
207    
208            /**
209             * Returns the description of this shopping category.
210             *
211             * @return the description of this shopping category
212             */
213            @AutoEscape
214            public String getDescription();
215    
216            /**
217             * Sets the description of this shopping category.
218             *
219             * @param description the description of this shopping category
220             */
221            public void setDescription(String description);
222    
223            public boolean isNew();
224    
225            public void setNew(boolean n);
226    
227            public boolean isCachedModel();
228    
229            public void setCachedModel(boolean cachedModel);
230    
231            public boolean isEscapedModel();
232    
233            public Serializable getPrimaryKeyObj();
234    
235            public void setPrimaryKeyObj(Serializable primaryKeyObj);
236    
237            public ExpandoBridge getExpandoBridge();
238    
239            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
240    
241            public Object clone();
242    
243            public int compareTo(ShoppingCategory shoppingCategory);
244    
245            public int hashCode();
246    
247            public CacheModel<ShoppingCategory> toCacheModel();
248    
249            public ShoppingCategory toEscapedModel();
250    
251            public ShoppingCategory toUnescapedModel();
252    
253            public String toString();
254    
255            public String toXmlString();
256    }