001 /** 002 * Copyright (c) 2000-present 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.document.library.kernel.model; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.expando.kernel.model.ExpandoBridge; 020 021 import com.liferay.portal.kernel.bean.AutoEscape; 022 import com.liferay.portal.kernel.exception.PortalException; 023 import com.liferay.portal.kernel.model.BaseModel; 024 import com.liferay.portal.kernel.model.CacheModel; 025 import com.liferay.portal.kernel.model.ShardedModel; 026 import com.liferay.portal.kernel.model.StagedGroupedModel; 027 import com.liferay.portal.kernel.model.TrashedModel; 028 import com.liferay.portal.kernel.model.WorkflowedModel; 029 import com.liferay.portal.kernel.service.ServiceContext; 030 import com.liferay.portal.kernel.trash.TrashHandler; 031 032 import com.liferay.trash.kernel.model.TrashEntry; 033 034 import java.io.Serializable; 035 036 import java.util.Date; 037 038 /** 039 * 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. 040 * 041 * <p> 042 * 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}. 043 * </p> 044 * 045 * @author Brian Wing Shun Chan 046 * @see DLFileShortcut 047 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl 048 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl 049 * @generated 050 */ 051 @ProviderType 052 public interface DLFileShortcutModel extends BaseModel<DLFileShortcut>, 053 ShardedModel, StagedGroupedModel, TrashedModel, WorkflowedModel { 054 /* 055 * NOTE FOR DEVELOPERS: 056 * 057 * 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. 058 */ 059 060 /** 061 * Returns the primary key of this document library file shortcut. 062 * 063 * @return the primary key of this document library file shortcut 064 */ 065 public long getPrimaryKey(); 066 067 /** 068 * Sets the primary key of this document library file shortcut. 069 * 070 * @param primaryKey the primary key of this document library file shortcut 071 */ 072 public void setPrimaryKey(long primaryKey); 073 074 /** 075 * Returns the uuid of this document library file shortcut. 076 * 077 * @return the uuid of this document library file shortcut 078 */ 079 @AutoEscape 080 @Override 081 public String getUuid(); 082 083 /** 084 * Sets the uuid of this document library file shortcut. 085 * 086 * @param uuid the uuid of this document library file shortcut 087 */ 088 @Override 089 public void setUuid(String uuid); 090 091 /** 092 * Returns the file shortcut ID of this document library file shortcut. 093 * 094 * @return the file shortcut ID of this document library file shortcut 095 */ 096 public long getFileShortcutId(); 097 098 /** 099 * Sets the file shortcut ID of this document library file shortcut. 100 * 101 * @param fileShortcutId the file shortcut ID of this document library file shortcut 102 */ 103 public void setFileShortcutId(long fileShortcutId); 104 105 /** 106 * Returns the group ID of this document library file shortcut. 107 * 108 * @return the group ID of this document library file shortcut 109 */ 110 @Override 111 public long getGroupId(); 112 113 /** 114 * Sets the group ID of this document library file shortcut. 115 * 116 * @param groupId the group ID of this document library file shortcut 117 */ 118 @Override 119 public void setGroupId(long groupId); 120 121 /** 122 * Returns the company ID of this document library file shortcut. 123 * 124 * @return the company ID of this document library file shortcut 125 */ 126 @Override 127 public long getCompanyId(); 128 129 /** 130 * Sets the company ID of this document library file shortcut. 131 * 132 * @param companyId the company ID of this document library file shortcut 133 */ 134 @Override 135 public void setCompanyId(long companyId); 136 137 /** 138 * Returns the user ID of this document library file shortcut. 139 * 140 * @return the user ID of this document library file shortcut 141 */ 142 @Override 143 public long getUserId(); 144 145 /** 146 * Sets the user ID of this document library file shortcut. 147 * 148 * @param userId the user ID of this document library file shortcut 149 */ 150 @Override 151 public void setUserId(long userId); 152 153 /** 154 * Returns the user uuid of this document library file shortcut. 155 * 156 * @return the user uuid of this document library file shortcut 157 */ 158 @Override 159 public String getUserUuid(); 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 last publish date of this document library file shortcut. 298 * 299 * @return the last publish date of this document library file shortcut 300 */ 301 @Override 302 public Date getLastPublishDate(); 303 304 /** 305 * Sets the last publish date of this document library file shortcut. 306 * 307 * @param lastPublishDate the last publish date of this document library file shortcut 308 */ 309 @Override 310 public void setLastPublishDate(Date lastPublishDate); 311 312 /** 313 * Returns the status of this document library file shortcut. 314 * 315 * @return the status of this document library file shortcut 316 */ 317 @Override 318 public int getStatus(); 319 320 /** 321 * Sets the status of this document library file shortcut. 322 * 323 * @param status the status of this document library file shortcut 324 */ 325 @Override 326 public void setStatus(int status); 327 328 /** 329 * Returns the status by user ID of this document library file shortcut. 330 * 331 * @return the status by user ID of this document library file shortcut 332 */ 333 @Override 334 public long getStatusByUserId(); 335 336 /** 337 * Sets the status by user ID of this document library file shortcut. 338 * 339 * @param statusByUserId the status by user ID of this document library file shortcut 340 */ 341 @Override 342 public void setStatusByUserId(long statusByUserId); 343 344 /** 345 * Returns the status by user uuid of this document library file shortcut. 346 * 347 * @return the status by user uuid of this document library file shortcut 348 */ 349 @Override 350 public String getStatusByUserUuid(); 351 352 /** 353 * Sets the status by user uuid of this document library file shortcut. 354 * 355 * @param statusByUserUuid the status by user uuid of this document library file shortcut 356 */ 357 @Override 358 public void setStatusByUserUuid(String statusByUserUuid); 359 360 /** 361 * Returns the status by user name of this document library file shortcut. 362 * 363 * @return the status by user name of this document library file shortcut 364 */ 365 @AutoEscape 366 @Override 367 public String getStatusByUserName(); 368 369 /** 370 * Sets the status by user name of this document library file shortcut. 371 * 372 * @param statusByUserName the status by user name of this document library file shortcut 373 */ 374 @Override 375 public void setStatusByUserName(String statusByUserName); 376 377 /** 378 * Returns the status date of this document library file shortcut. 379 * 380 * @return the status date of this document library file shortcut 381 */ 382 @Override 383 public Date getStatusDate(); 384 385 /** 386 * Sets the status date of this document library file shortcut. 387 * 388 * @param statusDate the status date of this document library file shortcut 389 */ 390 @Override 391 public void setStatusDate(Date statusDate); 392 393 /** 394 * 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. 395 * 396 * @return the trash entry created when this document library file shortcut was moved to the Recycle Bin 397 */ 398 @Override 399 public TrashEntry getTrashEntry() throws PortalException; 400 401 /** 402 * Returns the class primary key of the trash entry for this document library file shortcut. 403 * 404 * @return the class primary key of the trash entry for this document library file shortcut 405 */ 406 @Override 407 public long getTrashEntryClassPK(); 408 409 /** 410 * Returns the trash handler for this document library file shortcut. 411 * 412 * @return the trash handler for this document library file shortcut 413 */ 414 @Override 415 public TrashHandler getTrashHandler(); 416 417 /** 418 * Returns <code>true</code> if this document library file shortcut is in the Recycle Bin. 419 * 420 * @return <code>true</code> if this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise 421 */ 422 @Override 423 public boolean isInTrash(); 424 425 /** 426 * Returns <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin. 427 * 428 * @return <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise 429 */ 430 @Override 431 public boolean isInTrashContainer(); 432 433 @Override 434 public boolean isInTrashExplicitly(); 435 436 @Override 437 public boolean isInTrashImplicitly(); 438 439 /** 440 * Returns <code>true</code> if this document library file shortcut is approved. 441 * 442 * @return <code>true</code> if this document library file shortcut is approved; <code>false</code> otherwise 443 */ 444 @Override 445 public boolean isApproved(); 446 447 /** 448 * Returns <code>true</code> if this document library file shortcut is denied. 449 * 450 * @return <code>true</code> if this document library file shortcut is denied; <code>false</code> otherwise 451 */ 452 @Override 453 public boolean isDenied(); 454 455 /** 456 * Returns <code>true</code> if this document library file shortcut is a draft. 457 * 458 * @return <code>true</code> if this document library file shortcut is a draft; <code>false</code> otherwise 459 */ 460 @Override 461 public boolean isDraft(); 462 463 /** 464 * Returns <code>true</code> if this document library file shortcut is expired. 465 * 466 * @return <code>true</code> if this document library file shortcut is expired; <code>false</code> otherwise 467 */ 468 @Override 469 public boolean isExpired(); 470 471 /** 472 * Returns <code>true</code> if this document library file shortcut is inactive. 473 * 474 * @return <code>true</code> if this document library file shortcut is inactive; <code>false</code> otherwise 475 */ 476 @Override 477 public boolean isInactive(); 478 479 /** 480 * Returns <code>true</code> if this document library file shortcut is incomplete. 481 * 482 * @return <code>true</code> if this document library file shortcut is incomplete; <code>false</code> otherwise 483 */ 484 @Override 485 public boolean isIncomplete(); 486 487 /** 488 * Returns <code>true</code> if this document library file shortcut is pending. 489 * 490 * @return <code>true</code> if this document library file shortcut is pending; <code>false</code> otherwise 491 */ 492 @Override 493 public boolean isPending(); 494 495 /** 496 * Returns <code>true</code> if this document library file shortcut is scheduled. 497 * 498 * @return <code>true</code> if this document library file shortcut is scheduled; <code>false</code> otherwise 499 */ 500 @Override 501 public boolean isScheduled(); 502 503 @Override 504 public boolean isNew(); 505 506 @Override 507 public void setNew(boolean n); 508 509 @Override 510 public boolean isCachedModel(); 511 512 @Override 513 public void setCachedModel(boolean cachedModel); 514 515 @Override 516 public boolean isEscapedModel(); 517 518 @Override 519 public Serializable getPrimaryKeyObj(); 520 521 @Override 522 public void setPrimaryKeyObj(Serializable primaryKeyObj); 523 524 @Override 525 public ExpandoBridge getExpandoBridge(); 526 527 @Override 528 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 529 530 @Override 531 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 532 533 @Override 534 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 535 536 @Override 537 public Object clone(); 538 539 @Override 540 public int compareTo( 541 com.liferay.document.library.kernel.model.DLFileShortcut dlFileShortcut); 542 543 @Override 544 public int hashCode(); 545 546 @Override 547 public CacheModel<com.liferay.document.library.kernel.model.DLFileShortcut> toCacheModel(); 548 549 @Override 550 public com.liferay.document.library.kernel.model.DLFileShortcut toEscapedModel(); 551 552 @Override 553 public com.liferay.document.library.kernel.model.DLFileShortcut toUnescapedModel(); 554 555 @Override 556 public String toString(); 557 558 @Override 559 public String toXmlString(); 560 }