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