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