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