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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.AutoEscape; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 import com.liferay.portal.kernel.trash.TrashHandler; 023 import com.liferay.portal.model.BaseModel; 024 import com.liferay.portal.model.CacheModel; 025 import com.liferay.portal.model.StagedGroupedModel; 026 import com.liferay.portal.model.TrashedModel; 027 import com.liferay.portal.model.WorkflowedModel; 028 import com.liferay.portal.service.ServiceContext; 029 030 import com.liferay.portlet.expando.model.ExpandoBridge; 031 import com.liferay.portlet.trash.model.TrashEntry; 032 033 import java.io.Serializable; 034 035 import java.util.Date; 036 037 /** 038 * 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. 039 * 040 * <p> 041 * 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}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see DLFileShortcut 046 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl 047 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface DLFileShortcutModel extends BaseModel<DLFileShortcut>, 052 StagedGroupedModel, TrashedModel, WorkflowedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * 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. 057 */ 058 059 /** 060 * Returns the primary key of this document library file shortcut. 061 * 062 * @return the primary key of this document library file shortcut 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this document library file shortcut. 068 * 069 * @param primaryKey the primary key of this document library file shortcut 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this document library file shortcut. 075 * 076 * @return the uuid of this document library file shortcut 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this document library file shortcut. 084 * 085 * @param uuid the uuid of this document library file shortcut 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the file shortcut ID of this document library file shortcut. 092 * 093 * @return the file shortcut ID of this document library file shortcut 094 */ 095 public long getFileShortcutId(); 096 097 /** 098 * Sets the file shortcut ID of this document library file shortcut. 099 * 100 * @param fileShortcutId the file shortcut ID of this document library file shortcut 101 */ 102 public void setFileShortcutId(long fileShortcutId); 103 104 /** 105 * Returns the group ID of this document library file shortcut. 106 * 107 * @return the group ID of this document library file shortcut 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this document library file shortcut. 114 * 115 * @param groupId the group ID of this document library file shortcut 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this document library file shortcut. 122 * 123 * @return the company ID of this document library file shortcut 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this document library file shortcut. 130 * 131 * @param companyId the company ID of this document library file shortcut 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this document library file shortcut. 138 * 139 * @return the user ID of this document library file shortcut 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this document library file shortcut. 146 * 147 * @param userId the user ID of this document library file shortcut 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this document library file shortcut. 154 * 155 * @return the user uuid of this document library file shortcut 156 * @throws SystemException if a system exception occurred 157 */ 158 @Override 159 public String getUserUuid() throws SystemException; 160 161 /** 162 * Sets the user uuid of this document library file shortcut. 163 * 164 * @param userUuid the user uuid of this document library file shortcut 165 */ 166 @Override 167 public void setUserUuid(String userUuid); 168 169 /** 170 * Returns the user name of this document library file shortcut. 171 * 172 * @return the user name of this document library file shortcut 173 */ 174 @AutoEscape 175 @Override 176 public String getUserName(); 177 178 /** 179 * Sets the user name of this document library file shortcut. 180 * 181 * @param userName the user name of this document library file shortcut 182 */ 183 @Override 184 public void setUserName(String userName); 185 186 /** 187 * Returns the create date of this document library file shortcut. 188 * 189 * @return the create date of this document library file shortcut 190 */ 191 @Override 192 public Date getCreateDate(); 193 194 /** 195 * Sets the create date of this document library file shortcut. 196 * 197 * @param createDate the create date of this document library file shortcut 198 */ 199 @Override 200 public void setCreateDate(Date createDate); 201 202 /** 203 * Returns the modified date of this document library file shortcut. 204 * 205 * @return the modified date of this document library file shortcut 206 */ 207 @Override 208 public Date getModifiedDate(); 209 210 /** 211 * Sets the modified date of this document library file shortcut. 212 * 213 * @param modifiedDate the modified date of this document library file shortcut 214 */ 215 @Override 216 public void setModifiedDate(Date modifiedDate); 217 218 /** 219 * Returns the repository ID of this document library file shortcut. 220 * 221 * @return the repository ID of this document library file shortcut 222 */ 223 public long getRepositoryId(); 224 225 /** 226 * Sets the repository ID of this document library file shortcut. 227 * 228 * @param repositoryId the repository ID of this document library file shortcut 229 */ 230 public void setRepositoryId(long repositoryId); 231 232 /** 233 * Returns the folder ID of this document library file shortcut. 234 * 235 * @return the folder ID of this document library file shortcut 236 */ 237 public long getFolderId(); 238 239 /** 240 * Sets the folder ID of this document library file shortcut. 241 * 242 * @param folderId the folder ID of this document library file shortcut 243 */ 244 public void setFolderId(long folderId); 245 246 /** 247 * Returns the to file entry ID of this document library file shortcut. 248 * 249 * @return the to file entry ID of this document library file shortcut 250 */ 251 public long getToFileEntryId(); 252 253 /** 254 * Sets the to file entry ID of this document library file shortcut. 255 * 256 * @param toFileEntryId the to file entry ID of this document library file shortcut 257 */ 258 public void setToFileEntryId(long toFileEntryId); 259 260 /** 261 * Returns the tree path of this document library file shortcut. 262 * 263 * @return the tree path of this document library file shortcut 264 */ 265 @AutoEscape 266 public String getTreePath(); 267 268 /** 269 * Sets the tree path of this document library file shortcut. 270 * 271 * @param treePath the tree path of this document library file shortcut 272 */ 273 public void setTreePath(String treePath); 274 275 /** 276 * Returns the active of this document library file shortcut. 277 * 278 * @return the active of this document library file shortcut 279 */ 280 public boolean getActive(); 281 282 /** 283 * Returns <code>true</code> if this document library file shortcut is active. 284 * 285 * @return <code>true</code> if this document library file shortcut is active; <code>false</code> otherwise 286 */ 287 public boolean isActive(); 288 289 /** 290 * Sets whether this document library file shortcut is active. 291 * 292 * @param active the active of this document library file shortcut 293 */ 294 public void setActive(boolean active); 295 296 /** 297 * Returns the status of this document library file shortcut. 298 * 299 * @return the status of this document library file shortcut 300 */ 301 @Override 302 public int getStatus(); 303 304 /** 305 * Sets the status of this document library file shortcut. 306 * 307 * @param status the status of this document library file shortcut 308 */ 309 @Override 310 public void setStatus(int status); 311 312 /** 313 * Returns the status by user ID of this document library file shortcut. 314 * 315 * @return the status by user ID of this document library file shortcut 316 */ 317 @Override 318 public long getStatusByUserId(); 319 320 /** 321 * Sets the status by user ID of this document library file shortcut. 322 * 323 * @param statusByUserId the status by user ID of this document library file shortcut 324 */ 325 @Override 326 public void setStatusByUserId(long statusByUserId); 327 328 /** 329 * Returns the status by user uuid of this document library file shortcut. 330 * 331 * @return the status by user uuid of this document library file shortcut 332 * @throws SystemException if a system exception occurred 333 */ 334 @Override 335 public String getStatusByUserUuid() throws SystemException; 336 337 /** 338 * Sets the status by user uuid of this document library file shortcut. 339 * 340 * @param statusByUserUuid the status by user uuid of this document library file shortcut 341 */ 342 @Override 343 public void setStatusByUserUuid(String statusByUserUuid); 344 345 /** 346 * Returns the status by user name of this document library file shortcut. 347 * 348 * @return the status by user name of this document library file shortcut 349 */ 350 @AutoEscape 351 @Override 352 public String getStatusByUserName(); 353 354 /** 355 * Sets the status by user name of this document library file shortcut. 356 * 357 * @param statusByUserName the status by user name of this document library file shortcut 358 */ 359 @Override 360 public void setStatusByUserName(String statusByUserName); 361 362 /** 363 * Returns the status date of this document library file shortcut. 364 * 365 * @return the status date of this document library file shortcut 366 */ 367 @Override 368 public Date getStatusDate(); 369 370 /** 371 * Sets the status date of this document library file shortcut. 372 * 373 * @param statusDate the status date of this document library file shortcut 374 */ 375 @Override 376 public void setStatusDate(Date statusDate); 377 378 /** 379 * Returns the trash entry created when this document library file shortcut was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library file shortcut. 380 * 381 * @return the trash entry created when this document library file shortcut was moved to the Recycle Bin 382 * @throws SystemException if a system exception occurred 383 */ 384 @Override 385 public TrashEntry getTrashEntry() throws PortalException, SystemException; 386 387 /** 388 * Returns the class primary key of the trash entry for this document library file shortcut. 389 * 390 * @return the class primary key of the trash entry for this document library file shortcut 391 */ 392 @Override 393 public long getTrashEntryClassPK(); 394 395 /** 396 * Returns the trash handler for this document library file shortcut. 397 * 398 * @return the trash handler for this document library file shortcut 399 */ 400 @Override 401 public TrashHandler getTrashHandler(); 402 403 /** 404 * Returns <code>true</code> if this document library file shortcut is in the Recycle Bin. 405 * 406 * @return <code>true</code> if this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise 407 */ 408 @Override 409 public boolean isInTrash(); 410 411 /** 412 * Returns <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin. 413 * 414 * @return <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise 415 * @throws SystemException if a system exception occurred 416 */ 417 @Override 418 public boolean isInTrashContainer(); 419 420 /** 421 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 422 */ 423 @Override 424 public boolean getApproved(); 425 426 /** 427 * Returns <code>true</code> if this document library file shortcut is approved. 428 * 429 * @return <code>true</code> if this document library file shortcut is approved; <code>false</code> otherwise 430 */ 431 @Override 432 public boolean isApproved(); 433 434 /** 435 * Returns <code>true</code> if this document library file shortcut is denied. 436 * 437 * @return <code>true</code> if this document library file shortcut is denied; <code>false</code> otherwise 438 */ 439 @Override 440 public boolean isDenied(); 441 442 /** 443 * Returns <code>true</code> if this document library file shortcut is a draft. 444 * 445 * @return <code>true</code> if this document library file shortcut is a draft; <code>false</code> otherwise 446 */ 447 @Override 448 public boolean isDraft(); 449 450 /** 451 * Returns <code>true</code> if this document library file shortcut is expired. 452 * 453 * @return <code>true</code> if this document library file shortcut is expired; <code>false</code> otherwise 454 */ 455 @Override 456 public boolean isExpired(); 457 458 /** 459 * Returns <code>true</code> if this document library file shortcut is inactive. 460 * 461 * @return <code>true</code> if this document library file shortcut is inactive; <code>false</code> otherwise 462 */ 463 @Override 464 public boolean isInactive(); 465 466 /** 467 * Returns <code>true</code> if this document library file shortcut is incomplete. 468 * 469 * @return <code>true</code> if this document library file shortcut is incomplete; <code>false</code> otherwise 470 */ 471 @Override 472 public boolean isIncomplete(); 473 474 /** 475 * Returns <code>true</code> if this document library file shortcut is pending. 476 * 477 * @return <code>true</code> if this document library file shortcut is pending; <code>false</code> otherwise 478 */ 479 @Override 480 public boolean isPending(); 481 482 /** 483 * Returns <code>true</code> if this document library file shortcut is scheduled. 484 * 485 * @return <code>true</code> if this document library file shortcut is scheduled; <code>false</code> otherwise 486 */ 487 @Override 488 public boolean isScheduled(); 489 490 @Override 491 public boolean isNew(); 492 493 @Override 494 public void setNew(boolean n); 495 496 @Override 497 public boolean isCachedModel(); 498 499 @Override 500 public void setCachedModel(boolean cachedModel); 501 502 @Override 503 public boolean isEscapedModel(); 504 505 @Override 506 public Serializable getPrimaryKeyObj(); 507 508 @Override 509 public void setPrimaryKeyObj(Serializable primaryKeyObj); 510 511 @Override 512 public ExpandoBridge getExpandoBridge(); 513 514 @Override 515 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 516 517 @Override 518 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 519 520 @Override 521 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 522 523 @Override 524 public Object clone(); 525 526 @Override 527 public int compareTo(DLFileShortcut dlFileShortcut); 528 529 @Override 530 public int hashCode(); 531 532 @Override 533 public CacheModel<DLFileShortcut> toCacheModel(); 534 535 @Override 536 public DLFileShortcut toEscapedModel(); 537 538 @Override 539 public DLFileShortcut toUnescapedModel(); 540 541 @Override 542 public String toString(); 543 544 @Override 545 public String toXmlString(); 546 }