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            @Override
085            public long getGroupId();
086    
087            /**
088             * Sets the group ID of this shopping category.
089             *
090             * @param groupId the group ID of this shopping category
091             */
092            @Override
093            public void setGroupId(long groupId);
094    
095            /**
096             * Returns the company ID of this shopping category.
097             *
098             * @return the company ID of this shopping category
099             */
100            @Override
101            public long getCompanyId();
102    
103            /**
104             * Sets the company ID of this shopping category.
105             *
106             * @param companyId the company ID of this shopping category
107             */
108            @Override
109            public void setCompanyId(long companyId);
110    
111            /**
112             * Returns the user ID of this shopping category.
113             *
114             * @return the user ID of this shopping category
115             */
116            @Override
117            public long getUserId();
118    
119            /**
120             * Sets the user ID of this shopping category.
121             *
122             * @param userId the user ID of this shopping category
123             */
124            @Override
125            public void setUserId(long userId);
126    
127            /**
128             * Returns the user uuid of this shopping category.
129             *
130             * @return the user uuid of this shopping category
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 category.
138             *
139             * @param userUuid the user uuid of this shopping category
140             */
141            @Override
142            public void setUserUuid(String userUuid);
143    
144            /**
145             * Returns the user name of this shopping category.
146             *
147             * @return the user name of this shopping category
148             */
149            @AutoEscape
150            @Override
151            public String getUserName();
152    
153            /**
154             * Sets the user name of this shopping category.
155             *
156             * @param userName the user name of this shopping category
157             */
158            @Override
159            public void setUserName(String userName);
160    
161            /**
162             * Returns the create date of this shopping category.
163             *
164             * @return the create date of this shopping category
165             */
166            @Override
167            public Date getCreateDate();
168    
169            /**
170             * Sets the create date of this shopping category.
171             *
172             * @param createDate the create date of this shopping category
173             */
174            @Override
175            public void setCreateDate(Date createDate);
176    
177            /**
178             * Returns the modified date of this shopping category.
179             *
180             * @return the modified date of this shopping category
181             */
182            @Override
183            public Date getModifiedDate();
184    
185            /**
186             * Sets the modified date of this shopping category.
187             *
188             * @param modifiedDate the modified date of this shopping category
189             */
190            @Override
191            public void setModifiedDate(Date modifiedDate);
192    
193            /**
194             * Returns the parent category ID of this shopping category.
195             *
196             * @return the parent category ID of this shopping category
197             */
198            public long getParentCategoryId();
199    
200            /**
201             * Sets the parent category ID of this shopping category.
202             *
203             * @param parentCategoryId the parent category ID of this shopping category
204             */
205            public void setParentCategoryId(long parentCategoryId);
206    
207            /**
208             * Returns the name of this shopping category.
209             *
210             * @return the name of this shopping category
211             */
212            @AutoEscape
213            public String getName();
214    
215            /**
216             * Sets the name of this shopping category.
217             *
218             * @param name the name of this shopping category
219             */
220            public void setName(String name);
221    
222            /**
223             * Returns the description of this shopping category.
224             *
225             * @return the description of this shopping category
226             */
227            @AutoEscape
228            public String getDescription();
229    
230            /**
231             * Sets the description of this shopping category.
232             *
233             * @param description the description of this shopping category
234             */
235            public void setDescription(String description);
236    
237            @Override
238            public boolean isNew();
239    
240            @Override
241            public void setNew(boolean n);
242    
243            @Override
244            public boolean isCachedModel();
245    
246            @Override
247            public void setCachedModel(boolean cachedModel);
248    
249            @Override
250            public boolean isEscapedModel();
251    
252            @Override
253            public Serializable getPrimaryKeyObj();
254    
255            @Override
256            public void setPrimaryKeyObj(Serializable primaryKeyObj);
257    
258            @Override
259            public ExpandoBridge getExpandoBridge();
260    
261            @Override
262            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
263    
264            @Override
265            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
266    
267            @Override
268            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
269    
270            @Override
271            public Object clone();
272    
273            @Override
274            public int compareTo(ShoppingCategory shoppingCategory);
275    
276            @Override
277            public int hashCode();
278    
279            @Override
280            public CacheModel<ShoppingCategory> toCacheModel();
281    
282            @Override
283            public ShoppingCategory toEscapedModel();
284    
285            @Override
286            public ShoppingCategory toUnescapedModel();
287    
288            @Override
289            public String toString();
290    
291            @Override
292            public String toXmlString();
293    }