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.asset.model; 016 017 import com.liferay.portal.LocaleException; 018 import com.liferay.portal.kernel.bean.AutoEscape; 019 import com.liferay.portal.kernel.exception.SystemException; 020 import com.liferay.portal.model.AttachedModel; 021 import com.liferay.portal.model.BaseModel; 022 import com.liferay.portal.model.CacheModel; 023 import com.liferay.portal.model.GroupedModel; 024 import com.liferay.portal.service.ServiceContext; 025 026 import com.liferay.portlet.expando.model.ExpandoBridge; 027 028 import java.io.Serializable; 029 030 import java.util.Date; 031 import java.util.Locale; 032 import java.util.Map; 033 034 /** 035 * The base model interface for the AssetEntry service. Represents a row in the "AssetEntry" database table, with each column mapped to a property of this class. 036 * 037 * <p> 038 * This interface and its corresponding implementation {@link com.liferay.portlet.asset.model.impl.AssetEntryModelImpl} 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.asset.model.impl.AssetEntryImpl}. 039 * </p> 040 * 041 * @author Brian Wing Shun Chan 042 * @see AssetEntry 043 * @see com.liferay.portlet.asset.model.impl.AssetEntryImpl 044 * @see com.liferay.portlet.asset.model.impl.AssetEntryModelImpl 045 * @generated 046 */ 047 public interface AssetEntryModel extends AttachedModel, BaseModel<AssetEntry>, 048 GroupedModel { 049 /* 050 * NOTE FOR DEVELOPERS: 051 * 052 * Never modify or reference this interface directly. All methods that expect a asset entry model instance should use the {@link AssetEntry} interface instead. 053 */ 054 055 /** 056 * Returns the primary key of this asset entry. 057 * 058 * @return the primary key of this asset entry 059 */ 060 public long getPrimaryKey(); 061 062 /** 063 * Sets the primary key of this asset entry. 064 * 065 * @param primaryKey the primary key of this asset entry 066 */ 067 public void setPrimaryKey(long primaryKey); 068 069 /** 070 * Returns the entry ID of this asset entry. 071 * 072 * @return the entry ID of this asset entry 073 */ 074 public long getEntryId(); 075 076 /** 077 * Sets the entry ID of this asset entry. 078 * 079 * @param entryId the entry ID of this asset entry 080 */ 081 public void setEntryId(long entryId); 082 083 /** 084 * Returns the group ID of this asset entry. 085 * 086 * @return the group ID of this asset entry 087 */ 088 public long getGroupId(); 089 090 /** 091 * Sets the group ID of this asset entry. 092 * 093 * @param groupId the group ID of this asset entry 094 */ 095 public void setGroupId(long groupId); 096 097 /** 098 * Returns the company ID of this asset entry. 099 * 100 * @return the company ID of this asset entry 101 */ 102 public long getCompanyId(); 103 104 /** 105 * Sets the company ID of this asset entry. 106 * 107 * @param companyId the company ID of this asset entry 108 */ 109 public void setCompanyId(long companyId); 110 111 /** 112 * Returns the user ID of this asset entry. 113 * 114 * @return the user ID of this asset entry 115 */ 116 public long getUserId(); 117 118 /** 119 * Sets the user ID of this asset entry. 120 * 121 * @param userId the user ID of this asset entry 122 */ 123 public void setUserId(long userId); 124 125 /** 126 * Returns the user uuid of this asset entry. 127 * 128 * @return the user uuid of this asset entry 129 * @throws SystemException if a system exception occurred 130 */ 131 public String getUserUuid() throws SystemException; 132 133 /** 134 * Sets the user uuid of this asset entry. 135 * 136 * @param userUuid the user uuid of this asset entry 137 */ 138 public void setUserUuid(String userUuid); 139 140 /** 141 * Returns the user name of this asset entry. 142 * 143 * @return the user name of this asset entry 144 */ 145 @AutoEscape 146 public String getUserName(); 147 148 /** 149 * Sets the user name of this asset entry. 150 * 151 * @param userName the user name of this asset entry 152 */ 153 public void setUserName(String userName); 154 155 /** 156 * Returns the create date of this asset entry. 157 * 158 * @return the create date of this asset entry 159 */ 160 public Date getCreateDate(); 161 162 /** 163 * Sets the create date of this asset entry. 164 * 165 * @param createDate the create date of this asset entry 166 */ 167 public void setCreateDate(Date createDate); 168 169 /** 170 * Returns the modified date of this asset entry. 171 * 172 * @return the modified date of this asset entry 173 */ 174 public Date getModifiedDate(); 175 176 /** 177 * Sets the modified date of this asset entry. 178 * 179 * @param modifiedDate the modified date of this asset entry 180 */ 181 public void setModifiedDate(Date modifiedDate); 182 183 /** 184 * Returns the fully qualified class name of this asset entry. 185 * 186 * @return the fully qualified class name of this asset entry 187 */ 188 public String getClassName(); 189 190 public void setClassName(String className); 191 192 /** 193 * Returns the class name ID of this asset entry. 194 * 195 * @return the class name ID of this asset entry 196 */ 197 public long getClassNameId(); 198 199 /** 200 * Sets the class name ID of this asset entry. 201 * 202 * @param classNameId the class name ID of this asset entry 203 */ 204 public void setClassNameId(long classNameId); 205 206 /** 207 * Returns the class p k of this asset entry. 208 * 209 * @return the class p k of this asset entry 210 */ 211 public long getClassPK(); 212 213 /** 214 * Sets the class p k of this asset entry. 215 * 216 * @param classPK the class p k of this asset entry 217 */ 218 public void setClassPK(long classPK); 219 220 /** 221 * Returns the class uuid of this asset entry. 222 * 223 * @return the class uuid of this asset entry 224 */ 225 @AutoEscape 226 public String getClassUuid(); 227 228 /** 229 * Sets the class uuid of this asset entry. 230 * 231 * @param classUuid the class uuid of this asset entry 232 */ 233 public void setClassUuid(String classUuid); 234 235 /** 236 * Returns the class type ID of this asset entry. 237 * 238 * @return the class type ID of this asset entry 239 */ 240 public long getClassTypeId(); 241 242 /** 243 * Sets the class type ID of this asset entry. 244 * 245 * @param classTypeId the class type ID of this asset entry 246 */ 247 public void setClassTypeId(long classTypeId); 248 249 /** 250 * Returns the visible of this asset entry. 251 * 252 * @return the visible of this asset entry 253 */ 254 public boolean getVisible(); 255 256 /** 257 * Returns <code>true</code> if this asset entry is visible. 258 * 259 * @return <code>true</code> if this asset entry is visible; <code>false</code> otherwise 260 */ 261 public boolean isVisible(); 262 263 /** 264 * Sets whether this asset entry is visible. 265 * 266 * @param visible the visible of this asset entry 267 */ 268 public void setVisible(boolean visible); 269 270 /** 271 * Returns the start date of this asset entry. 272 * 273 * @return the start date of this asset entry 274 */ 275 public Date getStartDate(); 276 277 /** 278 * Sets the start date of this asset entry. 279 * 280 * @param startDate the start date of this asset entry 281 */ 282 public void setStartDate(Date startDate); 283 284 /** 285 * Returns the end date of this asset entry. 286 * 287 * @return the end date of this asset entry 288 */ 289 public Date getEndDate(); 290 291 /** 292 * Sets the end date of this asset entry. 293 * 294 * @param endDate the end date of this asset entry 295 */ 296 public void setEndDate(Date endDate); 297 298 /** 299 * Returns the publish date of this asset entry. 300 * 301 * @return the publish date of this asset entry 302 */ 303 public Date getPublishDate(); 304 305 /** 306 * Sets the publish date of this asset entry. 307 * 308 * @param publishDate the publish date of this asset entry 309 */ 310 public void setPublishDate(Date publishDate); 311 312 /** 313 * Returns the expiration date of this asset entry. 314 * 315 * @return the expiration date of this asset entry 316 */ 317 public Date getExpirationDate(); 318 319 /** 320 * Sets the expiration date of this asset entry. 321 * 322 * @param expirationDate the expiration date of this asset entry 323 */ 324 public void setExpirationDate(Date expirationDate); 325 326 /** 327 * Returns the mime type of this asset entry. 328 * 329 * @return the mime type of this asset entry 330 */ 331 @AutoEscape 332 public String getMimeType(); 333 334 /** 335 * Sets the mime type of this asset entry. 336 * 337 * @param mimeType the mime type of this asset entry 338 */ 339 public void setMimeType(String mimeType); 340 341 /** 342 * Returns the title of this asset entry. 343 * 344 * @return the title of this asset entry 345 */ 346 public String getTitle(); 347 348 /** 349 * Returns the localized title of this asset entry in the language. Uses the default language if no localization exists for the requested language. 350 * 351 * @param locale the locale of the language 352 * @return the localized title of this asset entry 353 */ 354 @AutoEscape 355 public String getTitle(Locale locale); 356 357 /** 358 * Returns the localized title of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 359 * 360 * @param locale the local of the language 361 * @param useDefault whether to use the default language if no localization exists for the requested language 362 * @return the localized title of this asset entry. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 363 */ 364 @AutoEscape 365 public String getTitle(Locale locale, boolean useDefault); 366 367 /** 368 * Returns the localized title of this asset entry in the language. Uses the default language if no localization exists for the requested language. 369 * 370 * @param languageId the ID of the language 371 * @return the localized title of this asset entry 372 */ 373 @AutoEscape 374 public String getTitle(String languageId); 375 376 /** 377 * Returns the localized title of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 378 * 379 * @param languageId the ID of the language 380 * @param useDefault whether to use the default language if no localization exists for the requested language 381 * @return the localized title of this asset entry 382 */ 383 @AutoEscape 384 public String getTitle(String languageId, boolean useDefault); 385 386 @AutoEscape 387 public String getTitleCurrentLanguageId(); 388 389 @AutoEscape 390 public String getTitleCurrentValue(); 391 392 /** 393 * Returns a map of the locales and localized titles of this asset entry. 394 * 395 * @return the locales and localized titles of this asset entry 396 */ 397 public Map<Locale, String> getTitleMap(); 398 399 /** 400 * Sets the title of this asset entry. 401 * 402 * @param title the title of this asset entry 403 */ 404 public void setTitle(String title); 405 406 /** 407 * Sets the localized title of this asset entry in the language. 408 * 409 * @param title the localized title of this asset entry 410 * @param locale the locale of the language 411 */ 412 public void setTitle(String title, Locale locale); 413 414 /** 415 * Sets the localized title of this asset entry in the language, and sets the default locale. 416 * 417 * @param title the localized title of this asset entry 418 * @param locale the locale of the language 419 * @param defaultLocale the default locale 420 */ 421 public void setTitle(String title, Locale locale, Locale defaultLocale); 422 423 public void setTitleCurrentLanguageId(String languageId); 424 425 /** 426 * Sets the localized titles of this asset entry from the map of locales and localized titles. 427 * 428 * @param titleMap the locales and localized titles of this asset entry 429 */ 430 public void setTitleMap(Map<Locale, String> titleMap); 431 432 /** 433 * Sets the localized titles of this asset entry from the map of locales and localized titles, and sets the default locale. 434 * 435 * @param titleMap the locales and localized titles of this asset entry 436 * @param defaultLocale the default locale 437 */ 438 public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale); 439 440 /** 441 * Returns the description of this asset entry. 442 * 443 * @return the description of this asset entry 444 */ 445 public String getDescription(); 446 447 /** 448 * Returns the localized description of this asset entry in the language. Uses the default language if no localization exists for the requested language. 449 * 450 * @param locale the locale of the language 451 * @return the localized description of this asset entry 452 */ 453 @AutoEscape 454 public String getDescription(Locale locale); 455 456 /** 457 * Returns the localized description of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 458 * 459 * @param locale the local of the language 460 * @param useDefault whether to use the default language if no localization exists for the requested language 461 * @return the localized description of this asset entry. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 462 */ 463 @AutoEscape 464 public String getDescription(Locale locale, boolean useDefault); 465 466 /** 467 * Returns the localized description of this asset entry in the language. Uses the default language if no localization exists for the requested language. 468 * 469 * @param languageId the ID of the language 470 * @return the localized description of this asset entry 471 */ 472 @AutoEscape 473 public String getDescription(String languageId); 474 475 /** 476 * Returns the localized description of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 477 * 478 * @param languageId the ID of the language 479 * @param useDefault whether to use the default language if no localization exists for the requested language 480 * @return the localized description of this asset entry 481 */ 482 @AutoEscape 483 public String getDescription(String languageId, boolean useDefault); 484 485 @AutoEscape 486 public String getDescriptionCurrentLanguageId(); 487 488 @AutoEscape 489 public String getDescriptionCurrentValue(); 490 491 /** 492 * Returns a map of the locales and localized descriptions of this asset entry. 493 * 494 * @return the locales and localized descriptions of this asset entry 495 */ 496 public Map<Locale, String> getDescriptionMap(); 497 498 /** 499 * Sets the description of this asset entry. 500 * 501 * @param description the description of this asset entry 502 */ 503 public void setDescription(String description); 504 505 /** 506 * Sets the localized description of this asset entry in the language. 507 * 508 * @param description the localized description of this asset entry 509 * @param locale the locale of the language 510 */ 511 public void setDescription(String description, Locale locale); 512 513 /** 514 * Sets the localized description of this asset entry in the language, and sets the default locale. 515 * 516 * @param description the localized description of this asset entry 517 * @param locale the locale of the language 518 * @param defaultLocale the default locale 519 */ 520 public void setDescription(String description, Locale locale, 521 Locale defaultLocale); 522 523 public void setDescriptionCurrentLanguageId(String languageId); 524 525 /** 526 * Sets the localized descriptions of this asset entry from the map of locales and localized descriptions. 527 * 528 * @param descriptionMap the locales and localized descriptions of this asset entry 529 */ 530 public void setDescriptionMap(Map<Locale, String> descriptionMap); 531 532 /** 533 * Sets the localized descriptions of this asset entry from the map of locales and localized descriptions, and sets the default locale. 534 * 535 * @param descriptionMap the locales and localized descriptions of this asset entry 536 * @param defaultLocale the default locale 537 */ 538 public void setDescriptionMap(Map<Locale, String> descriptionMap, 539 Locale defaultLocale); 540 541 /** 542 * Returns the summary of this asset entry. 543 * 544 * @return the summary of this asset entry 545 */ 546 public String getSummary(); 547 548 /** 549 * Returns the localized summary of this asset entry in the language. Uses the default language if no localization exists for the requested language. 550 * 551 * @param locale the locale of the language 552 * @return the localized summary of this asset entry 553 */ 554 @AutoEscape 555 public String getSummary(Locale locale); 556 557 /** 558 * Returns the localized summary of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 559 * 560 * @param locale the local of the language 561 * @param useDefault whether to use the default language if no localization exists for the requested language 562 * @return the localized summary of this asset entry. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 563 */ 564 @AutoEscape 565 public String getSummary(Locale locale, boolean useDefault); 566 567 /** 568 * Returns the localized summary of this asset entry in the language. Uses the default language if no localization exists for the requested language. 569 * 570 * @param languageId the ID of the language 571 * @return the localized summary of this asset entry 572 */ 573 @AutoEscape 574 public String getSummary(String languageId); 575 576 /** 577 * Returns the localized summary of this asset entry in the language, optionally using the default language if no localization exists for the requested language. 578 * 579 * @param languageId the ID of the language 580 * @param useDefault whether to use the default language if no localization exists for the requested language 581 * @return the localized summary of this asset entry 582 */ 583 @AutoEscape 584 public String getSummary(String languageId, boolean useDefault); 585 586 @AutoEscape 587 public String getSummaryCurrentLanguageId(); 588 589 @AutoEscape 590 public String getSummaryCurrentValue(); 591 592 /** 593 * Returns a map of the locales and localized summaries of this asset entry. 594 * 595 * @return the locales and localized summaries of this asset entry 596 */ 597 public Map<Locale, String> getSummaryMap(); 598 599 /** 600 * Sets the summary of this asset entry. 601 * 602 * @param summary the summary of this asset entry 603 */ 604 public void setSummary(String summary); 605 606 /** 607 * Sets the localized summary of this asset entry in the language. 608 * 609 * @param summary the localized summary of this asset entry 610 * @param locale the locale of the language 611 */ 612 public void setSummary(String summary, Locale locale); 613 614 /** 615 * Sets the localized summary of this asset entry in the language, and sets the default locale. 616 * 617 * @param summary the localized summary of this asset entry 618 * @param locale the locale of the language 619 * @param defaultLocale the default locale 620 */ 621 public void setSummary(String summary, Locale locale, Locale defaultLocale); 622 623 public void setSummaryCurrentLanguageId(String languageId); 624 625 /** 626 * Sets the localized summaries of this asset entry from the map of locales and localized summaries. 627 * 628 * @param summaryMap the locales and localized summaries of this asset entry 629 */ 630 public void setSummaryMap(Map<Locale, String> summaryMap); 631 632 /** 633 * Sets the localized summaries of this asset entry from the map of locales and localized summaries, and sets the default locale. 634 * 635 * @param summaryMap the locales and localized summaries of this asset entry 636 * @param defaultLocale the default locale 637 */ 638 public void setSummaryMap(Map<Locale, String> summaryMap, 639 Locale defaultLocale); 640 641 /** 642 * Returns the url of this asset entry. 643 * 644 * @return the url of this asset entry 645 */ 646 @AutoEscape 647 public String getUrl(); 648 649 /** 650 * Sets the url of this asset entry. 651 * 652 * @param url the url of this asset entry 653 */ 654 public void setUrl(String url); 655 656 /** 657 * Returns the layout uuid of this asset entry. 658 * 659 * @return the layout uuid of this asset entry 660 */ 661 @AutoEscape 662 public String getLayoutUuid(); 663 664 /** 665 * Sets the layout uuid of this asset entry. 666 * 667 * @param layoutUuid the layout uuid of this asset entry 668 */ 669 public void setLayoutUuid(String layoutUuid); 670 671 /** 672 * Returns the height of this asset entry. 673 * 674 * @return the height of this asset entry 675 */ 676 public int getHeight(); 677 678 /** 679 * Sets the height of this asset entry. 680 * 681 * @param height the height of this asset entry 682 */ 683 public void setHeight(int height); 684 685 /** 686 * Returns the width of this asset entry. 687 * 688 * @return the width of this asset entry 689 */ 690 public int getWidth(); 691 692 /** 693 * Sets the width of this asset entry. 694 * 695 * @param width the width of this asset entry 696 */ 697 public void setWidth(int width); 698 699 /** 700 * Returns the priority of this asset entry. 701 * 702 * @return the priority of this asset entry 703 */ 704 public double getPriority(); 705 706 /** 707 * Sets the priority of this asset entry. 708 * 709 * @param priority the priority of this asset entry 710 */ 711 public void setPriority(double priority); 712 713 /** 714 * Returns the view count of this asset entry. 715 * 716 * @return the view count of this asset entry 717 */ 718 public int getViewCount(); 719 720 /** 721 * Sets the view count of this asset entry. 722 * 723 * @param viewCount the view count of this asset entry 724 */ 725 public void setViewCount(int viewCount); 726 727 public boolean isNew(); 728 729 public void setNew(boolean n); 730 731 public boolean isCachedModel(); 732 733 public void setCachedModel(boolean cachedModel); 734 735 public boolean isEscapedModel(); 736 737 public Serializable getPrimaryKeyObj(); 738 739 public void setPrimaryKeyObj(Serializable primaryKeyObj); 740 741 public ExpandoBridge getExpandoBridge(); 742 743 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 744 745 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 746 throws LocaleException; 747 748 public Object clone(); 749 750 public int compareTo(AssetEntry assetEntry); 751 752 public int hashCode(); 753 754 public CacheModel<AssetEntry> toCacheModel(); 755 756 public AssetEntry toEscapedModel(); 757 758 public AssetEntry toUnescapedModel(); 759 760 public String toString(); 761 762 public String toXmlString(); 763 }