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