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