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