001 /** 002 * Copyright (c) 2000-2011 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.WorkflowedModel; 022 import com.liferay.portal.service.ServiceContext; 023 024 import com.liferay.portlet.expando.model.ExpandoBridge; 025 026 import java.io.Serializable; 027 028 import java.util.Date; 029 030 /** 031 * 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. 032 * 033 * <p> 034 * 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}. 035 * </p> 036 * 037 * @author Brian Wing Shun Chan 038 * @see DLFileVersion 039 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl 040 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl 041 * @generated 042 */ 043 public interface DLFileVersionModel extends BaseModel<DLFileVersion>, 044 WorkflowedModel { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * 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. 049 */ 050 051 /** 052 * Returns the primary key of this document library file version. 053 * 054 * @return the primary key of this document library file version 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this document library file version. 060 * 061 * @param primaryKey the primary key of this document library file version 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the file version ID of this document library file version. 067 * 068 * @return the file version ID of this document library file version 069 */ 070 public long getFileVersionId(); 071 072 /** 073 * Sets the file version ID of this document library file version. 074 * 075 * @param fileVersionId the file version ID of this document library file version 076 */ 077 public void setFileVersionId(long fileVersionId); 078 079 /** 080 * Returns the group ID of this document library file version. 081 * 082 * @return the group ID of this document library file version 083 */ 084 public long getGroupId(); 085 086 /** 087 * Sets the group ID of this document library file version. 088 * 089 * @param groupId the group ID of this document library file version 090 */ 091 public void setGroupId(long groupId); 092 093 /** 094 * Returns the company ID of this document library file version. 095 * 096 * @return the company ID of this document library file version 097 */ 098 public long getCompanyId(); 099 100 /** 101 * Sets the company ID of this document library file version. 102 * 103 * @param companyId the company ID of this document library file version 104 */ 105 public void setCompanyId(long companyId); 106 107 /** 108 * Returns the user ID of this document library file version. 109 * 110 * @return the user ID of this document library file version 111 */ 112 public long getUserId(); 113 114 /** 115 * Sets the user ID of this document library file version. 116 * 117 * @param userId the user ID of this document library file version 118 */ 119 public void setUserId(long userId); 120 121 /** 122 * Returns the user uuid of this document library file version. 123 * 124 * @return the user uuid of this document library file version 125 * @throws SystemException if a system exception occurred 126 */ 127 public String getUserUuid() throws SystemException; 128 129 /** 130 * Sets the user uuid of this document library file version. 131 * 132 * @param userUuid the user uuid of this document library file version 133 */ 134 public void setUserUuid(String userUuid); 135 136 /** 137 * Returns the user name of this document library file version. 138 * 139 * @return the user name of this document library file version 140 */ 141 @AutoEscape 142 public String getUserName(); 143 144 /** 145 * Sets the user name of this document library file version. 146 * 147 * @param userName the user name of this document library file version 148 */ 149 public void setUserName(String userName); 150 151 /** 152 * Returns the create date of this document library file version. 153 * 154 * @return the create date of this document library file version 155 */ 156 public Date getCreateDate(); 157 158 /** 159 * Sets the create date of this document library file version. 160 * 161 * @param createDate the create date of this document library file version 162 */ 163 public void setCreateDate(Date createDate); 164 165 /** 166 * Returns the repository ID of this document library file version. 167 * 168 * @return the repository ID of this document library file version 169 */ 170 public long getRepositoryId(); 171 172 /** 173 * Sets the repository ID of this document library file version. 174 * 175 * @param repositoryId the repository ID of this document library file version 176 */ 177 public void setRepositoryId(long repositoryId); 178 179 /** 180 * Returns the file entry ID of this document library file version. 181 * 182 * @return the file entry ID of this document library file version 183 */ 184 public long getFileEntryId(); 185 186 /** 187 * Sets the file entry ID of this document library file version. 188 * 189 * @param fileEntryId the file entry ID of this document library file version 190 */ 191 public void setFileEntryId(long fileEntryId); 192 193 /** 194 * Returns the extension of this document library file version. 195 * 196 * @return the extension of this document library file version 197 */ 198 @AutoEscape 199 public String getExtension(); 200 201 /** 202 * Sets the extension of this document library file version. 203 * 204 * @param extension the extension of this document library file version 205 */ 206 public void setExtension(String extension); 207 208 /** 209 * Returns the mime type of this document library file version. 210 * 211 * @return the mime type of this document library file version 212 */ 213 @AutoEscape 214 public String getMimeType(); 215 216 /** 217 * Sets the mime type of this document library file version. 218 * 219 * @param mimeType the mime type of this document library file version 220 */ 221 public void setMimeType(String mimeType); 222 223 /** 224 * Returns the title of this document library file version. 225 * 226 * @return the title of this document library file version 227 */ 228 @AutoEscape 229 public String getTitle(); 230 231 /** 232 * Sets the title of this document library file version. 233 * 234 * @param title the title of this document library file version 235 */ 236 public void setTitle(String title); 237 238 /** 239 * Returns the description of this document library file version. 240 * 241 * @return the description of this document library file version 242 */ 243 @AutoEscape 244 public String getDescription(); 245 246 /** 247 * Sets the description of this document library file version. 248 * 249 * @param description the description of this document library file version 250 */ 251 public void setDescription(String description); 252 253 /** 254 * Returns the change log of this document library file version. 255 * 256 * @return the change log of this document library file version 257 */ 258 @AutoEscape 259 public String getChangeLog(); 260 261 /** 262 * Sets the change log of this document library file version. 263 * 264 * @param changeLog the change log of this document library file version 265 */ 266 public void setChangeLog(String changeLog); 267 268 /** 269 * Returns the extra settings of this document library file version. 270 * 271 * @return the extra settings of this document library file version 272 */ 273 @AutoEscape 274 public String getExtraSettings(); 275 276 /** 277 * Sets the extra settings of this document library file version. 278 * 279 * @param extraSettings the extra settings of this document library file version 280 */ 281 public void setExtraSettings(String extraSettings); 282 283 /** 284 * Returns the file entry type ID of this document library file version. 285 * 286 * @return the file entry type ID of this document library file version 287 */ 288 public long getFileEntryTypeId(); 289 290 /** 291 * Sets the file entry type ID of this document library file version. 292 * 293 * @param fileEntryTypeId the file entry type ID of this document library file version 294 */ 295 public void setFileEntryTypeId(long fileEntryTypeId); 296 297 /** 298 * Returns the version of this document library file version. 299 * 300 * @return the version of this document library file version 301 */ 302 @AutoEscape 303 public String getVersion(); 304 305 /** 306 * Sets the version of this document library file version. 307 * 308 * @param version the version of this document library file version 309 */ 310 public void setVersion(String version); 311 312 /** 313 * Returns the size of this document library file version. 314 * 315 * @return the size of this document library file version 316 */ 317 public long getSize(); 318 319 /** 320 * Sets the size of this document library file version. 321 * 322 * @param size the size of this document library file version 323 */ 324 public void setSize(long size); 325 326 /** 327 * Returns the small image ID of this document library file version. 328 * 329 * @return the small image ID of this document library file version 330 */ 331 public long getSmallImageId(); 332 333 /** 334 * Sets the small image ID of this document library file version. 335 * 336 * @param smallImageId the small image ID of this document library file version 337 */ 338 public void setSmallImageId(long smallImageId); 339 340 /** 341 * Returns the large image ID of this document library file version. 342 * 343 * @return the large image ID of this document library file version 344 */ 345 public long getLargeImageId(); 346 347 /** 348 * Sets the large image ID of this document library file version. 349 * 350 * @param largeImageId the large image ID of this document library file version 351 */ 352 public void setLargeImageId(long largeImageId); 353 354 /** 355 * Returns the custom1 image ID of this document library file version. 356 * 357 * @return the custom1 image ID of this document library file version 358 */ 359 public long getCustom1ImageId(); 360 361 /** 362 * Sets the custom1 image ID of this document library file version. 363 * 364 * @param custom1ImageId the custom1 image ID of this document library file version 365 */ 366 public void setCustom1ImageId(long custom1ImageId); 367 368 /** 369 * Returns the custom2 image ID of this document library file version. 370 * 371 * @return the custom2 image ID of this document library file version 372 */ 373 public long getCustom2ImageId(); 374 375 /** 376 * Sets the custom2 image ID of this document library file version. 377 * 378 * @param custom2ImageId the custom2 image ID of this document library file version 379 */ 380 public void setCustom2ImageId(long custom2ImageId); 381 382 /** 383 * Returns the status of this document library file version. 384 * 385 * @return the status of this document library file version 386 */ 387 public int getStatus(); 388 389 /** 390 * Sets the status of this document library file version. 391 * 392 * @param status the status of this document library file version 393 */ 394 public void setStatus(int status); 395 396 /** 397 * Returns the status by user ID of this document library file version. 398 * 399 * @return the status by user ID of this document library file version 400 */ 401 public long getStatusByUserId(); 402 403 /** 404 * Sets the status by user ID of this document library file version. 405 * 406 * @param statusByUserId the status by user ID of this document library file version 407 */ 408 public void setStatusByUserId(long statusByUserId); 409 410 /** 411 * Returns the status by user uuid of this document library file version. 412 * 413 * @return the status by user uuid of this document library file version 414 * @throws SystemException if a system exception occurred 415 */ 416 public String getStatusByUserUuid() throws SystemException; 417 418 /** 419 * Sets the status by user uuid of this document library file version. 420 * 421 * @param statusByUserUuid the status by user uuid of this document library file version 422 */ 423 public void setStatusByUserUuid(String statusByUserUuid); 424 425 /** 426 * Returns the status by user name of this document library file version. 427 * 428 * @return the status by user name of this document library file version 429 */ 430 @AutoEscape 431 public String getStatusByUserName(); 432 433 /** 434 * Sets the status by user name of this document library file version. 435 * 436 * @param statusByUserName the status by user name of this document library file version 437 */ 438 public void setStatusByUserName(String statusByUserName); 439 440 /** 441 * Returns the status date of this document library file version. 442 * 443 * @return the status date of this document library file version 444 */ 445 public Date getStatusDate(); 446 447 /** 448 * Sets the status date of this document library file version. 449 * 450 * @param statusDate the status date of this document library file version 451 */ 452 public void setStatusDate(Date statusDate); 453 454 /** 455 * @deprecated Renamed to {@link #isApproved()} 456 */ 457 public boolean getApproved(); 458 459 /** 460 * Returns <code>true</code> if this document library file version is approved. 461 * 462 * @return <code>true</code> if this document library file version is approved; <code>false</code> otherwise 463 */ 464 public boolean isApproved(); 465 466 /** 467 * Returns <code>true</code> if this document library file version is a draft. 468 * 469 * @return <code>true</code> if this document library file version is a draft; <code>false</code> otherwise 470 */ 471 public boolean isDraft(); 472 473 /** 474 * Returns <code>true</code> if this document library file version is expired. 475 * 476 * @return <code>true</code> if this document library file version is expired; <code>false</code> otherwise 477 */ 478 public boolean isExpired(); 479 480 /** 481 * Returns <code>true</code> if this document library file version is pending. 482 * 483 * @return <code>true</code> if this document library file version is pending; <code>false</code> otherwise 484 */ 485 public boolean isPending(); 486 487 public boolean isNew(); 488 489 public void setNew(boolean n); 490 491 public boolean isCachedModel(); 492 493 public void setCachedModel(boolean cachedModel); 494 495 public boolean isEscapedModel(); 496 497 public Serializable getPrimaryKeyObj(); 498 499 public void setPrimaryKeyObj(Serializable primaryKeyObj); 500 501 public ExpandoBridge getExpandoBridge(); 502 503 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 504 505 public Object clone(); 506 507 public int compareTo(DLFileVersion dlFileVersion); 508 509 public int hashCode(); 510 511 public CacheModel<DLFileVersion> toCacheModel(); 512 513 public DLFileVersion toEscapedModel(); 514 515 public String toString(); 516 517 public String toXmlString(); 518 }