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