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.documentlibrary.model; 016 017 import com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.model.CacheModel; 021 import com.liferay.portal.model.GroupedModel; 022 import com.liferay.portal.model.WorkflowedModel; 023 import com.liferay.portal.service.ServiceContext; 024 025 import com.liferay.portlet.expando.model.ExpandoBridge; 026 027 import java.io.Serializable; 028 029 import java.util.Date; 030 031 /** 032 * The base model interface for the DLFileShortcut service. Represents a row in the "DLFileShortcut" database table, with each column mapped to a property of this class. 033 * 034 * <p> 035 * This interface and its corresponding implementation {@link com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl} 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.documentlibrary.model.impl.DLFileShortcutImpl}. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see DLFileShortcut 040 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl 041 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl 042 * @generated 043 */ 044 public interface DLFileShortcutModel extends BaseModel<DLFileShortcut>, 045 GroupedModel, WorkflowedModel { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. All methods that expect a document library file shortcut model instance should use the {@link DLFileShortcut} interface instead. 050 */ 051 052 /** 053 * Returns the primary key of this document library file shortcut. 054 * 055 * @return the primary key of this document library file shortcut 056 */ 057 public long getPrimaryKey(); 058 059 /** 060 * Sets the primary key of this document library file shortcut. 061 * 062 * @param primaryKey the primary key of this document library file shortcut 063 */ 064 public void setPrimaryKey(long primaryKey); 065 066 /** 067 * Returns the uuid of this document library file shortcut. 068 * 069 * @return the uuid of this document library file shortcut 070 */ 071 @AutoEscape 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this document library file shortcut. 076 * 077 * @param uuid the uuid of this document library file shortcut 078 */ 079 public void setUuid(String uuid); 080 081 /** 082 * Returns the file shortcut ID of this document library file shortcut. 083 * 084 * @return the file shortcut ID of this document library file shortcut 085 */ 086 public long getFileShortcutId(); 087 088 /** 089 * Sets the file shortcut ID of this document library file shortcut. 090 * 091 * @param fileShortcutId the file shortcut ID of this document library file shortcut 092 */ 093 public void setFileShortcutId(long fileShortcutId); 094 095 /** 096 * Returns the group ID of this document library file shortcut. 097 * 098 * @return the group ID of this document library file shortcut 099 */ 100 public long getGroupId(); 101 102 /** 103 * Sets the group ID of this document library file shortcut. 104 * 105 * @param groupId the group ID of this document library file shortcut 106 */ 107 public void setGroupId(long groupId); 108 109 /** 110 * Returns the company ID of this document library file shortcut. 111 * 112 * @return the company ID of this document library file shortcut 113 */ 114 public long getCompanyId(); 115 116 /** 117 * Sets the company ID of this document library file shortcut. 118 * 119 * @param companyId the company ID of this document library file shortcut 120 */ 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the user ID of this document library file shortcut. 125 * 126 * @return the user ID of this document library file shortcut 127 */ 128 public long getUserId(); 129 130 /** 131 * Sets the user ID of this document library file shortcut. 132 * 133 * @param userId the user ID of this document library file shortcut 134 */ 135 public void setUserId(long userId); 136 137 /** 138 * Returns the user uuid of this document library file shortcut. 139 * 140 * @return the user uuid of this document library file shortcut 141 * @throws SystemException if a system exception occurred 142 */ 143 public String getUserUuid() throws SystemException; 144 145 /** 146 * Sets the user uuid of this document library file shortcut. 147 * 148 * @param userUuid the user uuid of this document library file shortcut 149 */ 150 public void setUserUuid(String userUuid); 151 152 /** 153 * Returns the user name of this document library file shortcut. 154 * 155 * @return the user name of this document library file shortcut 156 */ 157 @AutoEscape 158 public String getUserName(); 159 160 /** 161 * Sets the user name of this document library file shortcut. 162 * 163 * @param userName the user name of this document library file shortcut 164 */ 165 public void setUserName(String userName); 166 167 /** 168 * Returns the create date of this document library file shortcut. 169 * 170 * @return the create date of this document library file shortcut 171 */ 172 public Date getCreateDate(); 173 174 /** 175 * Sets the create date of this document library file shortcut. 176 * 177 * @param createDate the create date of this document library file shortcut 178 */ 179 public void setCreateDate(Date createDate); 180 181 /** 182 * Returns the modified date of this document library file shortcut. 183 * 184 * @return the modified date of this document library file shortcut 185 */ 186 public Date getModifiedDate(); 187 188 /** 189 * Sets the modified date of this document library file shortcut. 190 * 191 * @param modifiedDate the modified date of this document library file shortcut 192 */ 193 public void setModifiedDate(Date modifiedDate); 194 195 /** 196 * Returns the repository ID of this document library file shortcut. 197 * 198 * @return the repository ID of this document library file shortcut 199 */ 200 public long getRepositoryId(); 201 202 /** 203 * Sets the repository ID of this document library file shortcut. 204 * 205 * @param repositoryId the repository ID of this document library file shortcut 206 */ 207 public void setRepositoryId(long repositoryId); 208 209 /** 210 * Returns the folder ID of this document library file shortcut. 211 * 212 * @return the folder ID of this document library file shortcut 213 */ 214 public long getFolderId(); 215 216 /** 217 * Sets the folder ID of this document library file shortcut. 218 * 219 * @param folderId the folder ID of this document library file shortcut 220 */ 221 public void setFolderId(long folderId); 222 223 /** 224 * Returns the to file entry ID of this document library file shortcut. 225 * 226 * @return the to file entry ID of this document library file shortcut 227 */ 228 public long getToFileEntryId(); 229 230 /** 231 * Sets the to file entry ID of this document library file shortcut. 232 * 233 * @param toFileEntryId the to file entry ID of this document library file shortcut 234 */ 235 public void setToFileEntryId(long toFileEntryId); 236 237 /** 238 * Returns the status of this document library file shortcut. 239 * 240 * @return the status of this document library file shortcut 241 */ 242 public int getStatus(); 243 244 /** 245 * Sets the status of this document library file shortcut. 246 * 247 * @param status the status of this document library file shortcut 248 */ 249 public void setStatus(int status); 250 251 /** 252 * Returns the status by user ID of this document library file shortcut. 253 * 254 * @return the status by user ID of this document library file shortcut 255 */ 256 public long getStatusByUserId(); 257 258 /** 259 * Sets the status by user ID of this document library file shortcut. 260 * 261 * @param statusByUserId the status by user ID of this document library file shortcut 262 */ 263 public void setStatusByUserId(long statusByUserId); 264 265 /** 266 * Returns the status by user uuid of this document library file shortcut. 267 * 268 * @return the status by user uuid of this document library file shortcut 269 * @throws SystemException if a system exception occurred 270 */ 271 public String getStatusByUserUuid() throws SystemException; 272 273 /** 274 * Sets the status by user uuid of this document library file shortcut. 275 * 276 * @param statusByUserUuid the status by user uuid of this document library file shortcut 277 */ 278 public void setStatusByUserUuid(String statusByUserUuid); 279 280 /** 281 * Returns the status by user name of this document library file shortcut. 282 * 283 * @return the status by user name of this document library file shortcut 284 */ 285 @AutoEscape 286 public String getStatusByUserName(); 287 288 /** 289 * Sets the status by user name of this document library file shortcut. 290 * 291 * @param statusByUserName the status by user name of this document library file shortcut 292 */ 293 public void setStatusByUserName(String statusByUserName); 294 295 /** 296 * Returns the status date of this document library file shortcut. 297 * 298 * @return the status date of this document library file shortcut 299 */ 300 public Date getStatusDate(); 301 302 /** 303 * Sets the status date of this document library file shortcut. 304 * 305 * @param statusDate the status date of this document library file shortcut 306 */ 307 public void setStatusDate(Date statusDate); 308 309 /** 310 * @deprecated Renamed to {@link #isApproved()} 311 */ 312 public boolean getApproved(); 313 314 /** 315 * Returns <code>true</code> if this document library file shortcut is approved. 316 * 317 * @return <code>true</code> if this document library file shortcut is approved; <code>false</code> otherwise 318 */ 319 public boolean isApproved(); 320 321 /** 322 * Returns <code>true</code> if this document library file shortcut is denied. 323 * 324 * @return <code>true</code> if this document library file shortcut is denied; <code>false</code> otherwise 325 */ 326 public boolean isDenied(); 327 328 /** 329 * Returns <code>true</code> if this document library file shortcut is a draft. 330 * 331 * @return <code>true</code> if this document library file shortcut is a draft; <code>false</code> otherwise 332 */ 333 public boolean isDraft(); 334 335 /** 336 * Returns <code>true</code> if this document library file shortcut is expired. 337 * 338 * @return <code>true</code> if this document library file shortcut is expired; <code>false</code> otherwise 339 */ 340 public boolean isExpired(); 341 342 /** 343 * Returns <code>true</code> if this document library file shortcut is inactive. 344 * 345 * @return <code>true</code> if this document library file shortcut is inactive; <code>false</code> otherwise 346 */ 347 public boolean isInactive(); 348 349 /** 350 * Returns <code>true</code> if this document library file shortcut is incomplete. 351 * 352 * @return <code>true</code> if this document library file shortcut is incomplete; <code>false</code> otherwise 353 */ 354 public boolean isIncomplete(); 355 356 /** 357 * Returns <code>true</code> if this document library file shortcut is pending. 358 * 359 * @return <code>true</code> if this document library file shortcut is pending; <code>false</code> otherwise 360 */ 361 public boolean isPending(); 362 363 /** 364 * Returns <code>true</code> if this document library file shortcut is scheduled. 365 * 366 * @return <code>true</code> if this document library file shortcut is scheduled; <code>false</code> otherwise 367 */ 368 public boolean isScheduled(); 369 370 public boolean isNew(); 371 372 public void setNew(boolean n); 373 374 public boolean isCachedModel(); 375 376 public void setCachedModel(boolean cachedModel); 377 378 public boolean isEscapedModel(); 379 380 public Serializable getPrimaryKeyObj(); 381 382 public void setPrimaryKeyObj(Serializable primaryKeyObj); 383 384 public ExpandoBridge getExpandoBridge(); 385 386 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 387 388 public Object clone(); 389 390 public int compareTo(DLFileShortcut dlFileShortcut); 391 392 public int hashCode(); 393 394 public CacheModel<DLFileShortcut> toCacheModel(); 395 396 public DLFileShortcut toEscapedModel(); 397 398 public DLFileShortcut toUnescapedModel(); 399 400 public String toString(); 401 402 public String toXmlString(); 403 }