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.AttachedModel; 024 import com.liferay.portal.model.BaseModel; 025 import com.liferay.portal.model.CacheModel; 026 import com.liferay.portal.model.StagedGroupedModel; 027 import com.liferay.portal.model.TrashedModel; 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 DLFileEntry service. Represents a row in the "DLFileEntry" 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.DLFileEntryModelImpl} 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.DLFileEntryImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see DLFileEntry 046 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileEntryImpl 047 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface DLFileEntryModel extends AttachedModel, BaseModel<DLFileEntry>, 052 StagedGroupedModel, TrashedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * Never modify or reference this interface directly. All methods that expect a document library file entry model instance should use the {@link DLFileEntry} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this document library file entry. 061 * 062 * @return the primary key of this document library file entry 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this document library file entry. 068 * 069 * @param primaryKey the primary key of this document library file entry 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this document library file entry. 075 * 076 * @return the uuid of this document library file entry 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this document library file entry. 084 * 085 * @param uuid the uuid of this document library file entry 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the file entry ID of this document library file entry. 092 * 093 * @return the file entry ID of this document library file entry 094 */ 095 public long getFileEntryId(); 096 097 /** 098 * Sets the file entry ID of this document library file entry. 099 * 100 * @param fileEntryId the file entry ID of this document library file entry 101 */ 102 public void setFileEntryId(long fileEntryId); 103 104 /** 105 * Returns the group ID of this document library file entry. 106 * 107 * @return the group ID of this document library file entry 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this document library file entry. 114 * 115 * @param groupId the group ID of this document library file entry 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this document library file entry. 122 * 123 * @return the company ID of this document library file entry 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this document library file entry. 130 * 131 * @param companyId the company ID of this document library file entry 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this document library file entry. 138 * 139 * @return the user ID of this document library file entry 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this document library file entry. 146 * 147 * @param userId the user ID of this document library file entry 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this document library file entry. 154 * 155 * @return the user uuid of this document library file entry 156 * @throws SystemException if a system exception occurred 157 */ 158 @Override 159 public String getUserUuid() throws SystemException; 160 161 /** 162 * Sets the user uuid of this document library file entry. 163 * 164 * @param userUuid the user uuid of this document library file entry 165 */ 166 @Override 167 public void setUserUuid(String userUuid); 168 169 /** 170 * Returns the user name of this document library file entry. 171 * 172 * @return the user name of this document library file entry 173 */ 174 @AutoEscape 175 @Override 176 public String getUserName(); 177 178 /** 179 * Sets the user name of this document library file entry. 180 * 181 * @param userName the user name of this document library file entry 182 */ 183 @Override 184 public void setUserName(String userName); 185 186 /** 187 * Returns the create date of this document library file entry. 188 * 189 * @return the create date of this document library file entry 190 */ 191 @Override 192 public Date getCreateDate(); 193 194 /** 195 * Sets the create date of this document library file entry. 196 * 197 * @param createDate the create date of this document library file entry 198 */ 199 @Override 200 public void setCreateDate(Date createDate); 201 202 /** 203 * Returns the modified date of this document library file entry. 204 * 205 * @return the modified date of this document library file entry 206 */ 207 @Override 208 public Date getModifiedDate(); 209 210 /** 211 * Sets the modified date of this document library file entry. 212 * 213 * @param modifiedDate the modified date of this document library file entry 214 */ 215 @Override 216 public void setModifiedDate(Date modifiedDate); 217 218 /** 219 * Returns the fully qualified class name of this document library file entry. 220 * 221 * @return the fully qualified class name of this document library file entry 222 */ 223 @Override 224 public String getClassName(); 225 226 public void setClassName(String className); 227 228 /** 229 * Returns the class name ID of this document library file entry. 230 * 231 * @return the class name ID of this document library file entry 232 */ 233 @Override 234 public long getClassNameId(); 235 236 /** 237 * Sets the class name ID of this document library file entry. 238 * 239 * @param classNameId the class name ID of this document library file entry 240 */ 241 @Override 242 public void setClassNameId(long classNameId); 243 244 /** 245 * Returns the class p k of this document library file entry. 246 * 247 * @return the class p k of this document library file entry 248 */ 249 @Override 250 public long getClassPK(); 251 252 /** 253 * Sets the class p k of this document library file entry. 254 * 255 * @param classPK the class p k of this document library file entry 256 */ 257 @Override 258 public void setClassPK(long classPK); 259 260 /** 261 * Returns the repository ID of this document library file entry. 262 * 263 * @return the repository ID of this document library file entry 264 */ 265 public long getRepositoryId(); 266 267 /** 268 * Sets the repository ID of this document library file entry. 269 * 270 * @param repositoryId the repository ID of this document library file entry 271 */ 272 public void setRepositoryId(long repositoryId); 273 274 /** 275 * Returns the folder ID of this document library file entry. 276 * 277 * @return the folder ID of this document library file entry 278 */ 279 public long getFolderId(); 280 281 /** 282 * Sets the folder ID of this document library file entry. 283 * 284 * @param folderId the folder ID of this document library file entry 285 */ 286 public void setFolderId(long folderId); 287 288 /** 289 * Returns the tree path of this document library file entry. 290 * 291 * @return the tree path of this document library file entry 292 */ 293 @AutoEscape 294 public String getTreePath(); 295 296 /** 297 * Sets the tree path of this document library file entry. 298 * 299 * @param treePath the tree path of this document library file entry 300 */ 301 public void setTreePath(String treePath); 302 303 /** 304 * Returns the name of this document library file entry. 305 * 306 * @return the name of this document library file entry 307 */ 308 @AutoEscape 309 public String getName(); 310 311 /** 312 * Sets the name of this document library file entry. 313 * 314 * @param name the name of this document library file entry 315 */ 316 public void setName(String name); 317 318 /** 319 * Returns the extension of this document library file entry. 320 * 321 * @return the extension of this document library file entry 322 */ 323 @AutoEscape 324 public String getExtension(); 325 326 /** 327 * Sets the extension of this document library file entry. 328 * 329 * @param extension the extension of this document library file entry 330 */ 331 public void setExtension(String extension); 332 333 /** 334 * Returns the mime type of this document library file entry. 335 * 336 * @return the mime type of this document library file entry 337 */ 338 @AutoEscape 339 public String getMimeType(); 340 341 /** 342 * Sets the mime type of this document library file entry. 343 * 344 * @param mimeType the mime type of this document library file entry 345 */ 346 public void setMimeType(String mimeType); 347 348 /** 349 * Returns the title of this document library file entry. 350 * 351 * @return the title of this document library file entry 352 */ 353 @AutoEscape 354 public String getTitle(); 355 356 /** 357 * Sets the title of this document library file entry. 358 * 359 * @param title the title of this document library file entry 360 */ 361 public void setTitle(String title); 362 363 /** 364 * Returns the description of this document library file entry. 365 * 366 * @return the description of this document library file entry 367 */ 368 @AutoEscape 369 public String getDescription(); 370 371 /** 372 * Sets the description of this document library file entry. 373 * 374 * @param description the description of this document library file entry 375 */ 376 public void setDescription(String description); 377 378 /** 379 * Returns the extra settings of this document library file entry. 380 * 381 * @return the extra settings of this document library file entry 382 */ 383 @AutoEscape 384 public String getExtraSettings(); 385 386 /** 387 * Sets the extra settings of this document library file entry. 388 * 389 * @param extraSettings the extra settings of this document library file entry 390 */ 391 public void setExtraSettings(String extraSettings); 392 393 /** 394 * Returns the file entry type ID of this document library file entry. 395 * 396 * @return the file entry type ID of this document library file entry 397 */ 398 public long getFileEntryTypeId(); 399 400 /** 401 * Sets the file entry type ID of this document library file entry. 402 * 403 * @param fileEntryTypeId the file entry type ID of this document library file entry 404 */ 405 public void setFileEntryTypeId(long fileEntryTypeId); 406 407 /** 408 * Returns the version of this document library file entry. 409 * 410 * @return the version of this document library file entry 411 */ 412 @AutoEscape 413 public String getVersion(); 414 415 /** 416 * Sets the version of this document library file entry. 417 * 418 * @param version the version of this document library file entry 419 */ 420 public void setVersion(String version); 421 422 /** 423 * Returns the size of this document library file entry. 424 * 425 * @return the size of this document library file entry 426 */ 427 public long getSize(); 428 429 /** 430 * Sets the size of this document library file entry. 431 * 432 * @param size the size of this document library file entry 433 */ 434 public void setSize(long size); 435 436 /** 437 * Returns the read count of this document library file entry. 438 * 439 * @return the read count of this document library file entry 440 */ 441 public int getReadCount(); 442 443 /** 444 * Sets the read count of this document library file entry. 445 * 446 * @param readCount the read count of this document library file entry 447 */ 448 public void setReadCount(int readCount); 449 450 /** 451 * Returns the small image ID of this document library file entry. 452 * 453 * @return the small image ID of this document library file entry 454 */ 455 public long getSmallImageId(); 456 457 /** 458 * Sets the small image ID of this document library file entry. 459 * 460 * @param smallImageId the small image ID of this document library file entry 461 */ 462 public void setSmallImageId(long smallImageId); 463 464 /** 465 * Returns the large image ID of this document library file entry. 466 * 467 * @return the large image ID of this document library file entry 468 */ 469 public long getLargeImageId(); 470 471 /** 472 * Sets the large image ID of this document library file entry. 473 * 474 * @param largeImageId the large image ID of this document library file entry 475 */ 476 public void setLargeImageId(long largeImageId); 477 478 /** 479 * Returns the custom1 image ID of this document library file entry. 480 * 481 * @return the custom1 image ID of this document library file entry 482 */ 483 public long getCustom1ImageId(); 484 485 /** 486 * Sets the custom1 image ID of this document library file entry. 487 * 488 * @param custom1ImageId the custom1 image ID of this document library file entry 489 */ 490 public void setCustom1ImageId(long custom1ImageId); 491 492 /** 493 * Returns the custom2 image ID of this document library file entry. 494 * 495 * @return the custom2 image ID of this document library file entry 496 */ 497 public long getCustom2ImageId(); 498 499 /** 500 * Sets the custom2 image ID of this document library file entry. 501 * 502 * @param custom2ImageId the custom2 image ID of this document library file entry 503 */ 504 public void setCustom2ImageId(long custom2ImageId); 505 506 /** 507 * Returns the manual check in required of this document library file entry. 508 * 509 * @return the manual check in required of this document library file entry 510 */ 511 public boolean getManualCheckInRequired(); 512 513 /** 514 * Returns <code>true</code> if this document library file entry is manual check in required. 515 * 516 * @return <code>true</code> if this document library file entry is manual check in required; <code>false</code> otherwise 517 */ 518 public boolean isManualCheckInRequired(); 519 520 /** 521 * Sets whether this document library file entry is manual check in required. 522 * 523 * @param manualCheckInRequired the manual check in required of this document library file entry 524 */ 525 public void setManualCheckInRequired(boolean manualCheckInRequired); 526 527 /** 528 * Returns the status of this document library file entry. 529 * 530 * @return the status of this document library file entry 531 */ 532 @Override 533 public int getStatus(); 534 535 /** 536 * Returns the trash entry created when this document library file entry was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library file entry. 537 * 538 * @return the trash entry created when this document library file entry was moved to the Recycle Bin 539 * @throws SystemException if a system exception occurred 540 */ 541 @Override 542 public TrashEntry getTrashEntry() throws PortalException, SystemException; 543 544 /** 545 * Returns the class primary key of the trash entry for this document library file entry. 546 * 547 * @return the class primary key of the trash entry for this document library file entry 548 */ 549 @Override 550 public long getTrashEntryClassPK(); 551 552 /** 553 * Returns the trash handler for this document library file entry. 554 * 555 * @return the trash handler for this document library file entry 556 */ 557 @Override 558 public TrashHandler getTrashHandler(); 559 560 /** 561 * Returns <code>true</code> if this document library file entry is in the Recycle Bin. 562 * 563 * @return <code>true</code> if this document library file entry is in the Recycle Bin; <code>false</code> otherwise 564 */ 565 @Override 566 public boolean isInTrash(); 567 568 /** 569 * Returns <code>true</code> if the parent of this document library file entry is in the Recycle Bin. 570 * 571 * @return <code>true</code> if the parent of this document library file entry is in the Recycle Bin; <code>false</code> otherwise 572 * @throws SystemException if a system exception occurred 573 */ 574 @Override 575 public boolean isInTrashContainer(); 576 577 @Override 578 public boolean isNew(); 579 580 @Override 581 public void setNew(boolean n); 582 583 @Override 584 public boolean isCachedModel(); 585 586 @Override 587 public void setCachedModel(boolean cachedModel); 588 589 @Override 590 public boolean isEscapedModel(); 591 592 @Override 593 public Serializable getPrimaryKeyObj(); 594 595 @Override 596 public void setPrimaryKeyObj(Serializable primaryKeyObj); 597 598 @Override 599 public ExpandoBridge getExpandoBridge(); 600 601 @Override 602 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 603 604 @Override 605 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 606 607 @Override 608 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 609 610 @Override 611 public Object clone(); 612 613 @Override 614 public int compareTo(DLFileEntry dlFileEntry); 615 616 @Override 617 public int hashCode(); 618 619 @Override 620 public CacheModel<DLFileEntry> toCacheModel(); 621 622 @Override 623 public DLFileEntry toEscapedModel(); 624 625 @Override 626 public DLFileEntry toUnescapedModel(); 627 628 @Override 629 public String toString(); 630 631 @Override 632 public String toXmlString(); 633 }