001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.model;
016    
017    import com.liferay.portal.kernel.annotation.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     * <p>
035     * Never modify or reference this interface directly. All methods that expect a portlet item model instance should use the {@link PortletItem} interface instead.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see PortletItem
040     * @see com.liferay.portal.model.impl.PortletItemImpl
041     * @see com.liferay.portal.model.impl.PortletItemModelImpl
042     * @generated
043     */
044    public interface PortletItemModel extends BaseModel<PortletItem> {
045            /**
046             * Gets the primary key of this portlet item.
047             *
048             * @return the primary key of this portlet item
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this portlet item
054             *
055             * @param pk the primary key of this portlet item
056             */
057            public void setPrimaryKey(long pk);
058    
059            /**
060             * Gets the portlet item id of this portlet item.
061             *
062             * @return the portlet item id of this portlet item
063             */
064            public long getPortletItemId();
065    
066            /**
067             * Sets the portlet item id of this portlet item.
068             *
069             * @param portletItemId the portlet item id of this portlet item
070             */
071            public void setPortletItemId(long portletItemId);
072    
073            /**
074             * Gets the group id of this portlet item.
075             *
076             * @return the group id of this portlet item
077             */
078            public long getGroupId();
079    
080            /**
081             * Sets the group id of this portlet item.
082             *
083             * @param groupId the group id of this portlet item
084             */
085            public void setGroupId(long groupId);
086    
087            /**
088             * Gets the company id of this portlet item.
089             *
090             * @return the company id of this portlet item
091             */
092            public long getCompanyId();
093    
094            /**
095             * Sets the company id of this portlet item.
096             *
097             * @param companyId the company id of this portlet item
098             */
099            public void setCompanyId(long companyId);
100    
101            /**
102             * Gets the user id of this portlet item.
103             *
104             * @return the user id of this portlet item
105             */
106            public long getUserId();
107    
108            /**
109             * Sets the user id of this portlet item.
110             *
111             * @param userId the user id of this portlet item
112             */
113            public void setUserId(long userId);
114    
115            /**
116             * Gets the user uuid of this portlet item.
117             *
118             * @return the user uuid of this portlet item
119             * @throws SystemException if a system exception occurred
120             */
121            public String getUserUuid() throws SystemException;
122    
123            /**
124             * Sets the user uuid of this portlet item.
125             *
126             * @param userUuid the user uuid of this portlet item
127             */
128            public void setUserUuid(String userUuid);
129    
130            /**
131             * Gets the user name of this portlet item.
132             *
133             * @return the user name of this portlet item
134             */
135            @AutoEscape
136            public String getUserName();
137    
138            /**
139             * Sets the user name of this portlet item.
140             *
141             * @param userName the user name of this portlet item
142             */
143            public void setUserName(String userName);
144    
145            /**
146             * Gets the create date of this portlet item.
147             *
148             * @return the create date of this portlet item
149             */
150            public Date getCreateDate();
151    
152            /**
153             * Sets the create date of this portlet item.
154             *
155             * @param createDate the create date of this portlet item
156             */
157            public void setCreateDate(Date createDate);
158    
159            /**
160             * Gets the modified date of this portlet item.
161             *
162             * @return the modified date of this portlet item
163             */
164            public Date getModifiedDate();
165    
166            /**
167             * Sets the modified date of this portlet item.
168             *
169             * @param modifiedDate the modified date of this portlet item
170             */
171            public void setModifiedDate(Date modifiedDate);
172    
173            /**
174             * Gets the name of this portlet item.
175             *
176             * @return the name of this portlet item
177             */
178            @AutoEscape
179            public String getName();
180    
181            /**
182             * Sets the name of this portlet item.
183             *
184             * @param name the name of this portlet item
185             */
186            public void setName(String name);
187    
188            /**
189             * Gets the portlet id of this portlet item.
190             *
191             * @return the portlet id of this portlet item
192             */
193            @AutoEscape
194            public String getPortletId();
195    
196            /**
197             * Sets the portlet id of this portlet item.
198             *
199             * @param portletId the portlet id of this portlet item
200             */
201            public void setPortletId(String portletId);
202    
203            /**
204             * Gets the class name of the model instance this portlet item is polymorphically associated with.
205             *
206             * @return the class name of the model instance this portlet item is polymorphically associated with
207             */
208            public String getClassName();
209    
210            /**
211             * Gets the class name id of this portlet item.
212             *
213             * @return the class name id of this portlet item
214             */
215            public long getClassNameId();
216    
217            /**
218             * Sets the class name id of this portlet item.
219             *
220             * @param classNameId the class name id of this portlet item
221             */
222            public void setClassNameId(long classNameId);
223    
224            public boolean isNew();
225    
226            public void setNew(boolean n);
227    
228            public boolean isCachedModel();
229    
230            public void setCachedModel(boolean cachedModel);
231    
232            public boolean isEscapedModel();
233    
234            public void setEscapedModel(boolean escapedModel);
235    
236            public Serializable getPrimaryKeyObj();
237    
238            public ExpandoBridge getExpandoBridge();
239    
240            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
241    
242            public Object clone();
243    
244            public int compareTo(PortletItem portletItem);
245    
246            public int hashCode();
247    
248            public PortletItem toEscapedModel();
249    
250            public String toString();
251    
252            public String toXmlString();
253    }