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.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.trash.TrashHandler; 022 import com.liferay.portal.model.BaseModel; 023 import com.liferay.portal.model.CacheModel; 024 import com.liferay.portal.model.ContainerModel; 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 DLFolder service. Represents a row in the "DLFolder" 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.DLFolderModelImpl} 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.DLFolderImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see DLFolder 046 * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderImpl 047 * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface DLFolderModel extends BaseModel<DLFolder>, ContainerModel, 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 folder model instance should use the {@link DLFolder} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this document library folder. 061 * 062 * @return the primary key of this document library folder 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this document library folder. 068 * 069 * @param primaryKey the primary key of this document library folder 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this document library folder. 075 * 076 * @return the uuid of this document library folder 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this document library folder. 084 * 085 * @param uuid the uuid of this document library folder 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the folder ID of this document library folder. 092 * 093 * @return the folder ID of this document library folder 094 */ 095 public long getFolderId(); 096 097 /** 098 * Sets the folder ID of this document library folder. 099 * 100 * @param folderId the folder ID of this document library folder 101 */ 102 public void setFolderId(long folderId); 103 104 /** 105 * Returns the group ID of this document library folder. 106 * 107 * @return the group ID of this document library folder 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this document library folder. 114 * 115 * @param groupId the group ID of this document library folder 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this document library folder. 122 * 123 * @return the company ID of this document library folder 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this document library folder. 130 * 131 * @param companyId the company ID of this document library folder 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this document library folder. 138 * 139 * @return the user ID of this document library folder 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this document library folder. 146 * 147 * @param userId the user ID of this document library folder 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this document library folder. 154 * 155 * @return the user uuid of this document library folder 156 */ 157 @Override 158 public String getUserUuid(); 159 160 /** 161 * Sets the user uuid of this document library folder. 162 * 163 * @param userUuid the user uuid of this document library folder 164 */ 165 @Override 166 public void setUserUuid(String userUuid); 167 168 /** 169 * Returns the user name of this document library folder. 170 * 171 * @return the user name of this document library folder 172 */ 173 @AutoEscape 174 @Override 175 public String getUserName(); 176 177 /** 178 * Sets the user name of this document library folder. 179 * 180 * @param userName the user name of this document library folder 181 */ 182 @Override 183 public void setUserName(String userName); 184 185 /** 186 * Returns the create date of this document library folder. 187 * 188 * @return the create date of this document library folder 189 */ 190 @Override 191 public Date getCreateDate(); 192 193 /** 194 * Sets the create date of this document library folder. 195 * 196 * @param createDate the create date of this document library folder 197 */ 198 @Override 199 public void setCreateDate(Date createDate); 200 201 /** 202 * Returns the modified date of this document library folder. 203 * 204 * @return the modified date of this document library folder 205 */ 206 @Override 207 public Date getModifiedDate(); 208 209 /** 210 * Sets the modified date of this document library folder. 211 * 212 * @param modifiedDate the modified date of this document library folder 213 */ 214 @Override 215 public void setModifiedDate(Date modifiedDate); 216 217 /** 218 * Returns the repository ID of this document library folder. 219 * 220 * @return the repository ID of this document library folder 221 */ 222 public long getRepositoryId(); 223 224 /** 225 * Sets the repository ID of this document library folder. 226 * 227 * @param repositoryId the repository ID of this document library folder 228 */ 229 public void setRepositoryId(long repositoryId); 230 231 /** 232 * Returns the mount point of this document library folder. 233 * 234 * @return the mount point of this document library folder 235 */ 236 public boolean getMountPoint(); 237 238 /** 239 * Returns <code>true</code> if this document library folder is mount point. 240 * 241 * @return <code>true</code> if this document library folder is mount point; <code>false</code> otherwise 242 */ 243 public boolean isMountPoint(); 244 245 /** 246 * Sets whether this document library folder is mount point. 247 * 248 * @param mountPoint the mount point of this document library folder 249 */ 250 public void setMountPoint(boolean mountPoint); 251 252 /** 253 * Returns the parent folder ID of this document library folder. 254 * 255 * @return the parent folder ID of this document library folder 256 */ 257 public long getParentFolderId(); 258 259 /** 260 * Sets the parent folder ID of this document library folder. 261 * 262 * @param parentFolderId the parent folder ID of this document library folder 263 */ 264 public void setParentFolderId(long parentFolderId); 265 266 /** 267 * Returns the tree path of this document library folder. 268 * 269 * @return the tree path of this document library folder 270 */ 271 @AutoEscape 272 public String getTreePath(); 273 274 /** 275 * Sets the tree path of this document library folder. 276 * 277 * @param treePath the tree path of this document library folder 278 */ 279 public void setTreePath(String treePath); 280 281 /** 282 * Returns the name of this document library folder. 283 * 284 * @return the name of this document library folder 285 */ 286 @AutoEscape 287 public String getName(); 288 289 /** 290 * Sets the name of this document library folder. 291 * 292 * @param name the name of this document library folder 293 */ 294 public void setName(String name); 295 296 /** 297 * Returns the description of this document library folder. 298 * 299 * @return the description of this document library folder 300 */ 301 @AutoEscape 302 public String getDescription(); 303 304 /** 305 * Sets the description of this document library folder. 306 * 307 * @param description the description of this document library folder 308 */ 309 public void setDescription(String description); 310 311 /** 312 * Returns the last post date of this document library folder. 313 * 314 * @return the last post date of this document library folder 315 */ 316 public Date getLastPostDate(); 317 318 /** 319 * Sets the last post date of this document library folder. 320 * 321 * @param lastPostDate the last post date of this document library folder 322 */ 323 public void setLastPostDate(Date lastPostDate); 324 325 /** 326 * Returns the default file entry type ID of this document library folder. 327 * 328 * @return the default file entry type ID of this document library folder 329 */ 330 public long getDefaultFileEntryTypeId(); 331 332 /** 333 * Sets the default file entry type ID of this document library folder. 334 * 335 * @param defaultFileEntryTypeId the default file entry type ID of this document library folder 336 */ 337 public void setDefaultFileEntryTypeId(long defaultFileEntryTypeId); 338 339 /** 340 * Returns the hidden of this document library folder. 341 * 342 * @return the hidden of this document library folder 343 */ 344 public boolean getHidden(); 345 346 /** 347 * Returns <code>true</code> if this document library folder is hidden. 348 * 349 * @return <code>true</code> if this document library folder is hidden; <code>false</code> otherwise 350 */ 351 public boolean isHidden(); 352 353 /** 354 * Sets whether this document library folder is hidden. 355 * 356 * @param hidden the hidden of this document library folder 357 */ 358 public void setHidden(boolean hidden); 359 360 /** 361 * Returns the override file entry types of this document library folder. 362 * 363 * @return the override file entry types of this document library folder 364 */ 365 public boolean getOverrideFileEntryTypes(); 366 367 /** 368 * Returns <code>true</code> if this document library folder is override file entry types. 369 * 370 * @return <code>true</code> if this document library folder is override file entry types; <code>false</code> otherwise 371 */ 372 public boolean isOverrideFileEntryTypes(); 373 374 /** 375 * Sets whether this document library folder is override file entry types. 376 * 377 * @param overrideFileEntryTypes the override file entry types of this document library folder 378 */ 379 public void setOverrideFileEntryTypes(boolean overrideFileEntryTypes); 380 381 /** 382 * Returns the status of this document library folder. 383 * 384 * @return the status of this document library folder 385 */ 386 @Override 387 public int getStatus(); 388 389 /** 390 * Sets the status of this document library folder. 391 * 392 * @param status the status of this document library folder 393 */ 394 @Override 395 public void setStatus(int status); 396 397 /** 398 * Returns the status by user ID of this document library folder. 399 * 400 * @return the status by user ID of this document library folder 401 */ 402 @Override 403 public long getStatusByUserId(); 404 405 /** 406 * Sets the status by user ID of this document library folder. 407 * 408 * @param statusByUserId the status by user ID of this document library folder 409 */ 410 @Override 411 public void setStatusByUserId(long statusByUserId); 412 413 /** 414 * Returns the status by user uuid of this document library folder. 415 * 416 * @return the status by user uuid of this document library folder 417 */ 418 @Override 419 public String getStatusByUserUuid(); 420 421 /** 422 * Sets the status by user uuid of this document library folder. 423 * 424 * @param statusByUserUuid the status by user uuid of this document library folder 425 */ 426 @Override 427 public void setStatusByUserUuid(String statusByUserUuid); 428 429 /** 430 * Returns the status by user name of this document library folder. 431 * 432 * @return the status by user name of this document library folder 433 */ 434 @AutoEscape 435 @Override 436 public String getStatusByUserName(); 437 438 /** 439 * Sets the status by user name of this document library folder. 440 * 441 * @param statusByUserName the status by user name of this document library folder 442 */ 443 @Override 444 public void setStatusByUserName(String statusByUserName); 445 446 /** 447 * Returns the status date of this document library folder. 448 * 449 * @return the status date of this document library folder 450 */ 451 @Override 452 public Date getStatusDate(); 453 454 /** 455 * Sets the status date of this document library folder. 456 * 457 * @param statusDate the status date of this document library folder 458 */ 459 @Override 460 public void setStatusDate(Date statusDate); 461 462 /** 463 * Returns the trash entry created when this document library folder was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library folder. 464 * 465 * @return the trash entry created when this document library folder was moved to the Recycle Bin 466 */ 467 @Override 468 public TrashEntry getTrashEntry() throws PortalException; 469 470 /** 471 * Returns the class primary key of the trash entry for this document library folder. 472 * 473 * @return the class primary key of the trash entry for this document library folder 474 */ 475 @Override 476 public long getTrashEntryClassPK(); 477 478 /** 479 * Returns the trash handler for this document library folder. 480 * 481 * @return the trash handler for this document library folder 482 */ 483 @Override 484 public TrashHandler getTrashHandler(); 485 486 /** 487 * Returns <code>true</code> if this document library folder is in the Recycle Bin. 488 * 489 * @return <code>true</code> if this document library folder is in the Recycle Bin; <code>false</code> otherwise 490 */ 491 @Override 492 public boolean isInTrash(); 493 494 /** 495 * Returns <code>true</code> if the parent of this document library folder is in the Recycle Bin. 496 * 497 * @return <code>true</code> if the parent of this document library folder is in the Recycle Bin; <code>false</code> otherwise 498 */ 499 @Override 500 public boolean isInTrashContainer(); 501 502 @Override 503 public boolean isInTrashExplicitly(); 504 505 @Override 506 public boolean isInTrashImplicitly(); 507 508 /** 509 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 510 */ 511 @Deprecated 512 @Override 513 public boolean getApproved(); 514 515 /** 516 * Returns <code>true</code> if this document library folder is approved. 517 * 518 * @return <code>true</code> if this document library folder is approved; <code>false</code> otherwise 519 */ 520 @Override 521 public boolean isApproved(); 522 523 /** 524 * Returns <code>true</code> if this document library folder is denied. 525 * 526 * @return <code>true</code> if this document library folder is denied; <code>false</code> otherwise 527 */ 528 @Override 529 public boolean isDenied(); 530 531 /** 532 * Returns <code>true</code> if this document library folder is a draft. 533 * 534 * @return <code>true</code> if this document library folder is a draft; <code>false</code> otherwise 535 */ 536 @Override 537 public boolean isDraft(); 538 539 /** 540 * Returns <code>true</code> if this document library folder is expired. 541 * 542 * @return <code>true</code> if this document library folder is expired; <code>false</code> otherwise 543 */ 544 @Override 545 public boolean isExpired(); 546 547 /** 548 * Returns <code>true</code> if this document library folder is inactive. 549 * 550 * @return <code>true</code> if this document library folder is inactive; <code>false</code> otherwise 551 */ 552 @Override 553 public boolean isInactive(); 554 555 /** 556 * Returns <code>true</code> if this document library folder is incomplete. 557 * 558 * @return <code>true</code> if this document library folder is incomplete; <code>false</code> otherwise 559 */ 560 @Override 561 public boolean isIncomplete(); 562 563 /** 564 * Returns <code>true</code> if this document library folder is pending. 565 * 566 * @return <code>true</code> if this document library folder is pending; <code>false</code> otherwise 567 */ 568 @Override 569 public boolean isPending(); 570 571 /** 572 * Returns <code>true</code> if this document library folder is scheduled. 573 * 574 * @return <code>true</code> if this document library folder is scheduled; <code>false</code> otherwise 575 */ 576 @Override 577 public boolean isScheduled(); 578 579 /** 580 * Returns the container model ID of this document library folder. 581 * 582 * @return the container model ID of this document library folder 583 */ 584 @Override 585 public long getContainerModelId(); 586 587 /** 588 * Sets the container model ID of this document library folder. 589 * 590 * @param containerModelId the container model ID of this document library folder 591 */ 592 @Override 593 public void setContainerModelId(long containerModelId); 594 595 /** 596 * Returns the container name of this document library folder. 597 * 598 * @return the container name of this document library folder 599 */ 600 @Override 601 public String getContainerModelName(); 602 603 /** 604 * Returns the parent container model ID of this document library folder. 605 * 606 * @return the parent container model ID of this document library folder 607 */ 608 @Override 609 public long getParentContainerModelId(); 610 611 /** 612 * Sets the parent container model ID of this document library folder. 613 * 614 * @param parentContainerModelId the parent container model ID of this document library folder 615 */ 616 @Override 617 public void setParentContainerModelId(long parentContainerModelId); 618 619 @Override 620 public boolean isNew(); 621 622 @Override 623 public void setNew(boolean n); 624 625 @Override 626 public boolean isCachedModel(); 627 628 @Override 629 public void setCachedModel(boolean cachedModel); 630 631 @Override 632 public boolean isEscapedModel(); 633 634 @Override 635 public Serializable getPrimaryKeyObj(); 636 637 @Override 638 public void setPrimaryKeyObj(Serializable primaryKeyObj); 639 640 @Override 641 public ExpandoBridge getExpandoBridge(); 642 643 @Override 644 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 645 646 @Override 647 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 648 649 @Override 650 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 651 652 @Override 653 public Object clone(); 654 655 @Override 656 public int compareTo(DLFolder dlFolder); 657 658 @Override 659 public int hashCode(); 660 661 @Override 662 public CacheModel<DLFolder> toCacheModel(); 663 664 @Override 665 public DLFolder toEscapedModel(); 666 667 @Override 668 public DLFolder toUnescapedModel(); 669 670 @Override 671 public String toString(); 672 673 @Override 674 public String toXmlString(); 675 }