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