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