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