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