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