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