001 /** 002 * Copyright (c) 2000-2012 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.GroupedModel; 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 GroupedModel, 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 public String getUuid(); 074 075 /** 076 * Sets the uuid of this document library folder. 077 * 078 * @param uuid the uuid of this document library folder 079 */ 080 public void setUuid(String uuid); 081 082 /** 083 * Returns the folder ID of this document library folder. 084 * 085 * @return the folder ID of this document library folder 086 */ 087 public long getFolderId(); 088 089 /** 090 * Sets the folder ID of this document library folder. 091 * 092 * @param folderId the folder ID of this document library folder 093 */ 094 public void setFolderId(long folderId); 095 096 /** 097 * Returns the group ID of this document library folder. 098 * 099 * @return the group ID of this document library folder 100 */ 101 public long getGroupId(); 102 103 /** 104 * Sets the group ID of this document library folder. 105 * 106 * @param groupId the group ID of this document library folder 107 */ 108 public void setGroupId(long groupId); 109 110 /** 111 * Returns the company ID of this document library folder. 112 * 113 * @return the company ID of this document library folder 114 */ 115 public long getCompanyId(); 116 117 /** 118 * Sets the company ID of this document library folder. 119 * 120 * @param companyId the company ID of this document library folder 121 */ 122 public void setCompanyId(long companyId); 123 124 /** 125 * Returns the user ID of this document library folder. 126 * 127 * @return the user ID of this document library folder 128 */ 129 public long getUserId(); 130 131 /** 132 * Sets the user ID of this document library folder. 133 * 134 * @param userId the user ID of this document library folder 135 */ 136 public void setUserId(long userId); 137 138 /** 139 * Returns the user uuid of this document library folder. 140 * 141 * @return the user uuid of this document library folder 142 * @throws SystemException if a system exception occurred 143 */ 144 public String getUserUuid() throws SystemException; 145 146 /** 147 * Sets the user uuid of this document library folder. 148 * 149 * @param userUuid the user uuid of this document library folder 150 */ 151 public void setUserUuid(String userUuid); 152 153 /** 154 * Returns the user name of this document library folder. 155 * 156 * @return the user name of this document library folder 157 */ 158 @AutoEscape 159 public String getUserName(); 160 161 /** 162 * Sets the user name of this document library folder. 163 * 164 * @param userName the user name of this document library folder 165 */ 166 public void setUserName(String userName); 167 168 /** 169 * Returns the create date of this document library folder. 170 * 171 * @return the create date of this document library folder 172 */ 173 public Date getCreateDate(); 174 175 /** 176 * Sets the create date of this document library folder. 177 * 178 * @param createDate the create date of this document library folder 179 */ 180 public void setCreateDate(Date createDate); 181 182 /** 183 * Returns the modified date of this document library folder. 184 * 185 * @return the modified date of this document library folder 186 */ 187 public Date getModifiedDate(); 188 189 /** 190 * Sets the modified date of this document library folder. 191 * 192 * @param modifiedDate the modified date of this document library folder 193 */ 194 public void setModifiedDate(Date modifiedDate); 195 196 /** 197 * Returns the repository ID of this document library folder. 198 * 199 * @return the repository ID of this document library folder 200 */ 201 public long getRepositoryId(); 202 203 /** 204 * Sets the repository ID of this document library folder. 205 * 206 * @param repositoryId the repository ID of this document library folder 207 */ 208 public void setRepositoryId(long repositoryId); 209 210 /** 211 * Returns the mount point of this document library folder. 212 * 213 * @return the mount point of this document library folder 214 */ 215 public boolean getMountPoint(); 216 217 /** 218 * Returns <code>true</code> if this document library folder is mount point. 219 * 220 * @return <code>true</code> if this document library folder is mount point; <code>false</code> otherwise 221 */ 222 public boolean isMountPoint(); 223 224 /** 225 * Sets whether this document library folder is mount point. 226 * 227 * @param mountPoint the mount point of this document library folder 228 */ 229 public void setMountPoint(boolean mountPoint); 230 231 /** 232 * Returns the parent folder ID of this document library folder. 233 * 234 * @return the parent folder ID of this document library folder 235 */ 236 public long getParentFolderId(); 237 238 /** 239 * Sets the parent folder ID of this document library folder. 240 * 241 * @param parentFolderId the parent folder ID of this document library folder 242 */ 243 public void setParentFolderId(long parentFolderId); 244 245 /** 246 * Returns the name of this document library folder. 247 * 248 * @return the name of this document library folder 249 */ 250 @AutoEscape 251 public String getName(); 252 253 /** 254 * Sets the name of this document library folder. 255 * 256 * @param name the name of this document library folder 257 */ 258 public void setName(String name); 259 260 /** 261 * Returns the description of this document library folder. 262 * 263 * @return the description of this document library folder 264 */ 265 @AutoEscape 266 public String getDescription(); 267 268 /** 269 * Sets the description of this document library folder. 270 * 271 * @param description the description of this document library folder 272 */ 273 public void setDescription(String description); 274 275 /** 276 * Returns the last post date of this document library folder. 277 * 278 * @return the last post date of this document library folder 279 */ 280 public Date getLastPostDate(); 281 282 /** 283 * Sets the last post date of this document library folder. 284 * 285 * @param lastPostDate the last post date of this document library folder 286 */ 287 public void setLastPostDate(Date lastPostDate); 288 289 /** 290 * Returns the default file entry type ID of this document library folder. 291 * 292 * @return the default file entry type ID of this document library folder 293 */ 294 public long getDefaultFileEntryTypeId(); 295 296 /** 297 * Sets the default file entry type ID of this document library folder. 298 * 299 * @param defaultFileEntryTypeId the default file entry type ID of this document library folder 300 */ 301 public void setDefaultFileEntryTypeId(long defaultFileEntryTypeId); 302 303 /** 304 * Returns the hidden of this document library folder. 305 * 306 * @return the hidden of this document library folder 307 */ 308 public boolean getHidden(); 309 310 /** 311 * Returns <code>true</code> if this document library folder is hidden. 312 * 313 * @return <code>true</code> if this document library folder is hidden; <code>false</code> otherwise 314 */ 315 public boolean isHidden(); 316 317 /** 318 * Sets whether this document library folder is hidden. 319 * 320 * @param hidden the hidden of this document library folder 321 */ 322 public void setHidden(boolean hidden); 323 324 /** 325 * Returns the override file entry types of this document library folder. 326 * 327 * @return the override file entry types of this document library folder 328 */ 329 public boolean getOverrideFileEntryTypes(); 330 331 /** 332 * Returns <code>true</code> if this document library folder is override file entry types. 333 * 334 * @return <code>true</code> if this document library folder is override file entry types; <code>false</code> otherwise 335 */ 336 public boolean isOverrideFileEntryTypes(); 337 338 /** 339 * Sets whether this document library folder is override file entry types. 340 * 341 * @param overrideFileEntryTypes the override file entry types of this document library folder 342 */ 343 public void setOverrideFileEntryTypes(boolean overrideFileEntryTypes); 344 345 /** 346 * Returns the status of this document library folder. 347 * 348 * @return the status of this document library folder 349 */ 350 public int getStatus(); 351 352 /** 353 * Sets the status of this document library folder. 354 * 355 * @param status the status of this document library folder 356 */ 357 public void setStatus(int status); 358 359 /** 360 * Returns the status by user ID of this document library folder. 361 * 362 * @return the status by user ID of this document library folder 363 */ 364 public long getStatusByUserId(); 365 366 /** 367 * Sets the status by user ID of this document library folder. 368 * 369 * @param statusByUserId the status by user ID of this document library folder 370 */ 371 public void setStatusByUserId(long statusByUserId); 372 373 /** 374 * Returns the status by user uuid of this document library folder. 375 * 376 * @return the status by user uuid of this document library folder 377 * @throws SystemException if a system exception occurred 378 */ 379 public String getStatusByUserUuid() throws SystemException; 380 381 /** 382 * Sets the status by user uuid of this document library folder. 383 * 384 * @param statusByUserUuid the status by user uuid of this document library folder 385 */ 386 public void setStatusByUserUuid(String statusByUserUuid); 387 388 /** 389 * Returns the status by user name of this document library folder. 390 * 391 * @return the status by user name of this document library folder 392 */ 393 @AutoEscape 394 public String getStatusByUserName(); 395 396 /** 397 * Sets the status by user name of this document library folder. 398 * 399 * @param statusByUserName the status by user name of this document library folder 400 */ 401 public void setStatusByUserName(String statusByUserName); 402 403 /** 404 * Returns the status date of this document library folder. 405 * 406 * @return the status date of this document library folder 407 */ 408 public Date getStatusDate(); 409 410 /** 411 * Sets the status date of this document library folder. 412 * 413 * @param statusDate the status date of this document library folder 414 */ 415 public void setStatusDate(Date statusDate); 416 417 /** 418 * @deprecated Renamed to {@link #isApproved()} 419 */ 420 public boolean getApproved(); 421 422 /** 423 * Returns <code>true</code> if this document library folder is approved. 424 * 425 * @return <code>true</code> if this document library folder is approved; <code>false</code> otherwise 426 */ 427 public boolean isApproved(); 428 429 /** 430 * Returns <code>true</code> if this document library folder is denied. 431 * 432 * @return <code>true</code> if this document library folder is denied; <code>false</code> otherwise 433 */ 434 public boolean isDenied(); 435 436 /** 437 * Returns <code>true</code> if this document library folder is a draft. 438 * 439 * @return <code>true</code> if this document library folder is a draft; <code>false</code> otherwise 440 */ 441 public boolean isDraft(); 442 443 /** 444 * Returns <code>true</code> if this document library folder is expired. 445 * 446 * @return <code>true</code> if this document library folder is expired; <code>false</code> otherwise 447 */ 448 public boolean isExpired(); 449 450 /** 451 * Returns <code>true</code> if this document library folder is inactive. 452 * 453 * @return <code>true</code> if this document library folder is inactive; <code>false</code> otherwise 454 */ 455 public boolean isInactive(); 456 457 /** 458 * Returns <code>true</code> if this document library folder is incomplete. 459 * 460 * @return <code>true</code> if this document library folder is incomplete; <code>false</code> otherwise 461 */ 462 public boolean isIncomplete(); 463 464 /** 465 * Returns <code>true</code> if this document library folder is in the Recycle Bin. 466 * 467 * @return <code>true</code> if this document library folder is in the Recycle Bin; <code>false</code> otherwise 468 */ 469 public boolean isInTrash(); 470 471 /** 472 * Returns <code>true</code> if this document library folder is pending. 473 * 474 * @return <code>true</code> if this document library folder is pending; <code>false</code> otherwise 475 */ 476 public boolean isPending(); 477 478 /** 479 * Returns <code>true</code> if this document library folder is scheduled. 480 * 481 * @return <code>true</code> if this document library folder is scheduled; <code>false</code> otherwise 482 */ 483 public boolean isScheduled(); 484 485 /** 486 * Returns the container model ID of this document library folder. 487 * 488 * @return the container model ID of this document library folder 489 */ 490 public long getContainerModelId(); 491 492 /** 493 * Sets the container model ID of this document library folder. 494 * 495 * @param container model ID of this document library folder 496 */ 497 public void setContainerModelId(long containerModelId); 498 499 /** 500 * Returns the container name of this document library folder. 501 * 502 * @return the container name of this document library folder 503 */ 504 public String getContainerModelName(); 505 506 /** 507 * Returns the parent container model ID of this document library folder. 508 * 509 * @return the parent container model ID of this document library folder 510 */ 511 public long getParentContainerModelId(); 512 513 /** 514 * Sets the parent container model ID of this document library folder. 515 * 516 * @param parent container model ID of this document library folder 517 */ 518 public void setParentContainerModelId(long parentContainerModelId); 519 520 public boolean isNew(); 521 522 public void setNew(boolean n); 523 524 public boolean isCachedModel(); 525 526 public void setCachedModel(boolean cachedModel); 527 528 public boolean isEscapedModel(); 529 530 public Serializable getPrimaryKeyObj(); 531 532 public void setPrimaryKeyObj(Serializable primaryKeyObj); 533 534 public ExpandoBridge getExpandoBridge(); 535 536 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 537 538 public Object clone(); 539 540 public int compareTo(DLFolder dlFolder); 541 542 public int hashCode(); 543 544 public CacheModel<DLFolder> toCacheModel(); 545 546 public DLFolder toEscapedModel(); 547 548 public String toString(); 549 550 public String toXmlString(); 551 }