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