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