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