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