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