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