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