001 /** 002 * Copyright (c) 2000-2012 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.journal.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.model.ResourcedModel; 025 import com.liferay.portal.model.StagedModel; 026 import com.liferay.portal.model.WorkflowedModel; 027 import com.liferay.portal.service.ServiceContext; 028 029 import com.liferay.portlet.expando.model.ExpandoBridge; 030 031 import java.io.Serializable; 032 033 import java.util.Date; 034 import java.util.Locale; 035 import java.util.Map; 036 037 /** 038 * The base model interface for the JournalArticle service. Represents a row in the "JournalArticle" database table, with each column mapped to a property of this class. 039 * 040 * <p> 041 * This interface and its corresponding implementation {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl} 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.journal.model.impl.JournalArticleImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see JournalArticle 046 * @see com.liferay.portlet.journal.model.impl.JournalArticleImpl 047 * @see com.liferay.portlet.journal.model.impl.JournalArticleModelImpl 048 * @generated 049 */ 050 public interface JournalArticleModel extends AttachedModel, 051 BaseModel<JournalArticle>, GroupedModel, ResourcedModel, StagedModel, 052 WorkflowedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * Never modify or reference this interface directly. All methods that expect a journal article model instance should use the {@link JournalArticle} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this journal article. 061 * 062 * @return the primary key of this journal article 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this journal article. 068 * 069 * @param primaryKey the primary key of this journal article 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this journal article. 075 * 076 * @return the uuid of this journal article 077 */ 078 @AutoEscape 079 public String getUuid(); 080 081 /** 082 * Sets the uuid of this journal article. 083 * 084 * @param uuid the uuid of this journal article 085 */ 086 public void setUuid(String uuid); 087 088 /** 089 * Returns the ID of this journal article. 090 * 091 * @return the ID of this journal article 092 */ 093 public long getId(); 094 095 /** 096 * Sets the ID of this journal article. 097 * 098 * @param id the ID of this journal article 099 */ 100 public void setId(long id); 101 102 /** 103 * Returns the resource prim key of this journal article. 104 * 105 * @return the resource prim key of this journal article 106 */ 107 public long getResourcePrimKey(); 108 109 /** 110 * Sets the resource prim key of this journal article. 111 * 112 * @param resourcePrimKey the resource prim key of this journal article 113 */ 114 public void setResourcePrimKey(long resourcePrimKey); 115 116 public boolean isResourceMain(); 117 118 /** 119 * Returns the group ID of this journal article. 120 * 121 * @return the group ID of this journal article 122 */ 123 public long getGroupId(); 124 125 /** 126 * Sets the group ID of this journal article. 127 * 128 * @param groupId the group ID of this journal article 129 */ 130 public void setGroupId(long groupId); 131 132 /** 133 * Returns the company ID of this journal article. 134 * 135 * @return the company ID of this journal article 136 */ 137 public long getCompanyId(); 138 139 /** 140 * Sets the company ID of this journal article. 141 * 142 * @param companyId the company ID of this journal article 143 */ 144 public void setCompanyId(long companyId); 145 146 /** 147 * Returns the user ID of this journal article. 148 * 149 * @return the user ID of this journal article 150 */ 151 public long getUserId(); 152 153 /** 154 * Sets the user ID of this journal article. 155 * 156 * @param userId the user ID of this journal article 157 */ 158 public void setUserId(long userId); 159 160 /** 161 * Returns the user uuid of this journal article. 162 * 163 * @return the user uuid of this journal article 164 * @throws SystemException if a system exception occurred 165 */ 166 public String getUserUuid() throws SystemException; 167 168 /** 169 * Sets the user uuid of this journal article. 170 * 171 * @param userUuid the user uuid of this journal article 172 */ 173 public void setUserUuid(String userUuid); 174 175 /** 176 * Returns the user name of this journal article. 177 * 178 * @return the user name of this journal article 179 */ 180 @AutoEscape 181 public String getUserName(); 182 183 /** 184 * Sets the user name of this journal article. 185 * 186 * @param userName the user name of this journal article 187 */ 188 public void setUserName(String userName); 189 190 /** 191 * Returns the create date of this journal article. 192 * 193 * @return the create date of this journal article 194 */ 195 public Date getCreateDate(); 196 197 /** 198 * Sets the create date of this journal article. 199 * 200 * @param createDate the create date of this journal article 201 */ 202 public void setCreateDate(Date createDate); 203 204 /** 205 * Returns the modified date of this journal article. 206 * 207 * @return the modified date of this journal article 208 */ 209 public Date getModifiedDate(); 210 211 /** 212 * Sets the modified date of this journal article. 213 * 214 * @param modifiedDate the modified date of this journal article 215 */ 216 public void setModifiedDate(Date modifiedDate); 217 218 /** 219 * Returns the folder ID of this journal article. 220 * 221 * @return the folder ID of this journal article 222 */ 223 public long getFolderId(); 224 225 /** 226 * Sets the folder ID of this journal article. 227 * 228 * @param folderId the folder ID of this journal article 229 */ 230 public void setFolderId(long folderId); 231 232 /** 233 * Returns the fully qualified class name of this journal article. 234 * 235 * @return the fully qualified class name of this journal article 236 */ 237 public String getClassName(); 238 239 public void setClassName(String className); 240 241 /** 242 * Returns the class name ID of this journal article. 243 * 244 * @return the class name ID of this journal article 245 */ 246 public long getClassNameId(); 247 248 /** 249 * Sets the class name ID of this journal article. 250 * 251 * @param classNameId the class name ID of this journal article 252 */ 253 public void setClassNameId(long classNameId); 254 255 /** 256 * Returns the class p k of this journal article. 257 * 258 * @return the class p k of this journal article 259 */ 260 public long getClassPK(); 261 262 /** 263 * Sets the class p k of this journal article. 264 * 265 * @param classPK the class p k of this journal article 266 */ 267 public void setClassPK(long classPK); 268 269 /** 270 * Returns the article ID of this journal article. 271 * 272 * @return the article ID of this journal article 273 */ 274 public String getArticleId(); 275 276 /** 277 * Sets the article ID of this journal article. 278 * 279 * @param articleId the article ID of this journal article 280 */ 281 public void setArticleId(String articleId); 282 283 /** 284 * Returns the version of this journal article. 285 * 286 * @return the version of this journal article 287 */ 288 public double getVersion(); 289 290 /** 291 * Sets the version of this journal article. 292 * 293 * @param version the version of this journal article 294 */ 295 public void setVersion(double version); 296 297 /** 298 * Returns the title of this journal article. 299 * 300 * @return the title of this journal article 301 */ 302 public String getTitle(); 303 304 /** 305 * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language. 306 * 307 * @param locale the locale of the language 308 * @return the localized title of this journal article 309 */ 310 @AutoEscape 311 public String getTitle(Locale locale); 312 313 /** 314 * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language. 315 * 316 * @param locale the local of the language 317 * @param useDefault whether to use the default language if no localization exists for the requested language 318 * @return the localized title of this journal article. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 319 */ 320 @AutoEscape 321 public String getTitle(Locale locale, boolean useDefault); 322 323 /** 324 * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language. 325 * 326 * @param languageId the ID of the language 327 * @return the localized title of this journal article 328 */ 329 @AutoEscape 330 public String getTitle(String languageId); 331 332 /** 333 * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language. 334 * 335 * @param languageId the ID of the language 336 * @param useDefault whether to use the default language if no localization exists for the requested language 337 * @return the localized title of this journal article 338 */ 339 @AutoEscape 340 public String getTitle(String languageId, boolean useDefault); 341 342 @AutoEscape 343 public String getTitleCurrentLanguageId(); 344 345 @AutoEscape 346 public String getTitleCurrentValue(); 347 348 /** 349 * Returns a map of the locales and localized titles of this journal article. 350 * 351 * @return the locales and localized titles of this journal article 352 */ 353 public Map<Locale, String> getTitleMap(); 354 355 /** 356 * Sets the title of this journal article. 357 * 358 * @param title the title of this journal article 359 */ 360 public void setTitle(String title); 361 362 /** 363 * Sets the localized title of this journal article in the language. 364 * 365 * @param title the localized title of this journal article 366 * @param locale the locale of the language 367 */ 368 public void setTitle(String title, Locale locale); 369 370 /** 371 * Sets the localized title of this journal article in the language, and sets the default locale. 372 * 373 * @param title the localized title of this journal article 374 * @param locale the locale of the language 375 * @param defaultLocale the default locale 376 */ 377 public void setTitle(String title, Locale locale, Locale defaultLocale); 378 379 public void setTitleCurrentLanguageId(String languageId); 380 381 /** 382 * Sets the localized titles of this journal article from the map of locales and localized titles. 383 * 384 * @param titleMap the locales and localized titles of this journal article 385 */ 386 public void setTitleMap(Map<Locale, String> titleMap); 387 388 /** 389 * Sets the localized titles of this journal article from the map of locales and localized titles, and sets the default locale. 390 * 391 * @param titleMap the locales and localized titles of this journal article 392 * @param defaultLocale the default locale 393 */ 394 public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale); 395 396 /** 397 * Returns the url title of this journal article. 398 * 399 * @return the url title of this journal article 400 */ 401 @AutoEscape 402 public String getUrlTitle(); 403 404 /** 405 * Sets the url title of this journal article. 406 * 407 * @param urlTitle the url title of this journal article 408 */ 409 public void setUrlTitle(String urlTitle); 410 411 /** 412 * Returns the description of this journal article. 413 * 414 * @return the description of this journal article 415 */ 416 public String getDescription(); 417 418 /** 419 * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language. 420 * 421 * @param locale the locale of the language 422 * @return the localized description of this journal article 423 */ 424 @AutoEscape 425 public String getDescription(Locale locale); 426 427 /** 428 * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language. 429 * 430 * @param locale the local of the language 431 * @param useDefault whether to use the default language if no localization exists for the requested language 432 * @return the localized description of this journal article. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 433 */ 434 @AutoEscape 435 public String getDescription(Locale locale, boolean useDefault); 436 437 /** 438 * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language. 439 * 440 * @param languageId the ID of the language 441 * @return the localized description of this journal article 442 */ 443 @AutoEscape 444 public String getDescription(String languageId); 445 446 /** 447 * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language. 448 * 449 * @param languageId the ID of the language 450 * @param useDefault whether to use the default language if no localization exists for the requested language 451 * @return the localized description of this journal article 452 */ 453 @AutoEscape 454 public String getDescription(String languageId, boolean useDefault); 455 456 @AutoEscape 457 public String getDescriptionCurrentLanguageId(); 458 459 @AutoEscape 460 public String getDescriptionCurrentValue(); 461 462 /** 463 * Returns a map of the locales and localized descriptions of this journal article. 464 * 465 * @return the locales and localized descriptions of this journal article 466 */ 467 public Map<Locale, String> getDescriptionMap(); 468 469 /** 470 * Sets the description of this journal article. 471 * 472 * @param description the description of this journal article 473 */ 474 public void setDescription(String description); 475 476 /** 477 * Sets the localized description of this journal article in the language. 478 * 479 * @param description the localized description of this journal article 480 * @param locale the locale of the language 481 */ 482 public void setDescription(String description, Locale locale); 483 484 /** 485 * Sets the localized description of this journal article in the language, and sets the default locale. 486 * 487 * @param description the localized description of this journal article 488 * @param locale the locale of the language 489 * @param defaultLocale the default locale 490 */ 491 public void setDescription(String description, Locale locale, 492 Locale defaultLocale); 493 494 public void setDescriptionCurrentLanguageId(String languageId); 495 496 /** 497 * Sets the localized descriptions of this journal article from the map of locales and localized descriptions. 498 * 499 * @param descriptionMap the locales and localized descriptions of this journal article 500 */ 501 public void setDescriptionMap(Map<Locale, String> descriptionMap); 502 503 /** 504 * Sets the localized descriptions of this journal article from the map of locales and localized descriptions, and sets the default locale. 505 * 506 * @param descriptionMap the locales and localized descriptions of this journal article 507 * @param defaultLocale the default locale 508 */ 509 public void setDescriptionMap(Map<Locale, String> descriptionMap, 510 Locale defaultLocale); 511 512 /** 513 * Returns the content of this journal article. 514 * 515 * @return the content of this journal article 516 */ 517 @AutoEscape 518 public String getContent(); 519 520 /** 521 * Sets the content of this journal article. 522 * 523 * @param content the content of this journal article 524 */ 525 public void setContent(String content); 526 527 /** 528 * Returns the type of this journal article. 529 * 530 * @return the type of this journal article 531 */ 532 @AutoEscape 533 public String getType(); 534 535 /** 536 * Sets the type of this journal article. 537 * 538 * @param type the type of this journal article 539 */ 540 public void setType(String type); 541 542 /** 543 * Returns the structure ID of this journal article. 544 * 545 * @return the structure ID of this journal article 546 */ 547 public String getStructureId(); 548 549 /** 550 * Sets the structure ID of this journal article. 551 * 552 * @param structureId the structure ID of this journal article 553 */ 554 public void setStructureId(String structureId); 555 556 /** 557 * Returns the template ID of this journal article. 558 * 559 * @return the template ID of this journal article 560 */ 561 public String getTemplateId(); 562 563 /** 564 * Sets the template ID of this journal article. 565 * 566 * @param templateId the template ID of this journal article 567 */ 568 public void setTemplateId(String templateId); 569 570 /** 571 * Returns the layout uuid of this journal article. 572 * 573 * @return the layout uuid of this journal article 574 */ 575 @AutoEscape 576 public String getLayoutUuid(); 577 578 /** 579 * Sets the layout uuid of this journal article. 580 * 581 * @param layoutUuid the layout uuid of this journal article 582 */ 583 public void setLayoutUuid(String layoutUuid); 584 585 /** 586 * Returns the display date of this journal article. 587 * 588 * @return the display date of this journal article 589 */ 590 public Date getDisplayDate(); 591 592 /** 593 * Sets the display date of this journal article. 594 * 595 * @param displayDate the display date of this journal article 596 */ 597 public void setDisplayDate(Date displayDate); 598 599 /** 600 * Returns the expiration date of this journal article. 601 * 602 * @return the expiration date of this journal article 603 */ 604 public Date getExpirationDate(); 605 606 /** 607 * Sets the expiration date of this journal article. 608 * 609 * @param expirationDate the expiration date of this journal article 610 */ 611 public void setExpirationDate(Date expirationDate); 612 613 /** 614 * Returns the review date of this journal article. 615 * 616 * @return the review date of this journal article 617 */ 618 public Date getReviewDate(); 619 620 /** 621 * Sets the review date of this journal article. 622 * 623 * @param reviewDate the review date of this journal article 624 */ 625 public void setReviewDate(Date reviewDate); 626 627 /** 628 * Returns the indexable of this journal article. 629 * 630 * @return the indexable of this journal article 631 */ 632 public boolean getIndexable(); 633 634 /** 635 * Returns <code>true</code> if this journal article is indexable. 636 * 637 * @return <code>true</code> if this journal article is indexable; <code>false</code> otherwise 638 */ 639 public boolean isIndexable(); 640 641 /** 642 * Sets whether this journal article is indexable. 643 * 644 * @param indexable the indexable of this journal article 645 */ 646 public void setIndexable(boolean indexable); 647 648 /** 649 * Returns the small image of this journal article. 650 * 651 * @return the small image of this journal article 652 */ 653 public boolean getSmallImage(); 654 655 /** 656 * Returns <code>true</code> if this journal article is small image. 657 * 658 * @return <code>true</code> if this journal article is small image; <code>false</code> otherwise 659 */ 660 public boolean isSmallImage(); 661 662 /** 663 * Sets whether this journal article is small image. 664 * 665 * @param smallImage the small image of this journal article 666 */ 667 public void setSmallImage(boolean smallImage); 668 669 /** 670 * Returns the small image ID of this journal article. 671 * 672 * @return the small image ID of this journal article 673 */ 674 public long getSmallImageId(); 675 676 /** 677 * Sets the small image ID of this journal article. 678 * 679 * @param smallImageId the small image ID of this journal article 680 */ 681 public void setSmallImageId(long smallImageId); 682 683 /** 684 * Returns the small image u r l of this journal article. 685 * 686 * @return the small image u r l of this journal article 687 */ 688 @AutoEscape 689 public String getSmallImageURL(); 690 691 /** 692 * Sets the small image u r l of this journal article. 693 * 694 * @param smallImageURL the small image u r l of this journal article 695 */ 696 public void setSmallImageURL(String smallImageURL); 697 698 /** 699 * Returns the status of this journal article. 700 * 701 * @return the status of this journal article 702 */ 703 public int getStatus(); 704 705 /** 706 * Sets the status of this journal article. 707 * 708 * @param status the status of this journal article 709 */ 710 public void setStatus(int status); 711 712 /** 713 * Returns the status by user ID of this journal article. 714 * 715 * @return the status by user ID of this journal article 716 */ 717 public long getStatusByUserId(); 718 719 /** 720 * Sets the status by user ID of this journal article. 721 * 722 * @param statusByUserId the status by user ID of this journal article 723 */ 724 public void setStatusByUserId(long statusByUserId); 725 726 /** 727 * Returns the status by user uuid of this journal article. 728 * 729 * @return the status by user uuid of this journal article 730 * @throws SystemException if a system exception occurred 731 */ 732 public String getStatusByUserUuid() throws SystemException; 733 734 /** 735 * Sets the status by user uuid of this journal article. 736 * 737 * @param statusByUserUuid the status by user uuid of this journal article 738 */ 739 public void setStatusByUserUuid(String statusByUserUuid); 740 741 /** 742 * Returns the status by user name of this journal article. 743 * 744 * @return the status by user name of this journal article 745 */ 746 @AutoEscape 747 public String getStatusByUserName(); 748 749 /** 750 * Sets the status by user name of this journal article. 751 * 752 * @param statusByUserName the status by user name of this journal article 753 */ 754 public void setStatusByUserName(String statusByUserName); 755 756 /** 757 * Returns the status date of this journal article. 758 * 759 * @return the status date of this journal article 760 */ 761 public Date getStatusDate(); 762 763 /** 764 * Sets the status date of this journal article. 765 * 766 * @param statusDate the status date of this journal article 767 */ 768 public void setStatusDate(Date statusDate); 769 770 /** 771 * @deprecated Renamed to {@link #isApproved()} 772 */ 773 public boolean getApproved(); 774 775 /** 776 * Returns <code>true</code> if this journal article is approved. 777 * 778 * @return <code>true</code> if this journal article is approved; <code>false</code> otherwise 779 */ 780 public boolean isApproved(); 781 782 /** 783 * Returns <code>true</code> if this journal article is denied. 784 * 785 * @return <code>true</code> if this journal article is denied; <code>false</code> otherwise 786 */ 787 public boolean isDenied(); 788 789 /** 790 * Returns <code>true</code> if this journal article is a draft. 791 * 792 * @return <code>true</code> if this journal article is a draft; <code>false</code> otherwise 793 */ 794 public boolean isDraft(); 795 796 /** 797 * Returns <code>true</code> if this journal article is expired. 798 * 799 * @return <code>true</code> if this journal article is expired; <code>false</code> otherwise 800 */ 801 public boolean isExpired(); 802 803 /** 804 * Returns <code>true</code> if this journal article is inactive. 805 * 806 * @return <code>true</code> if this journal article is inactive; <code>false</code> otherwise 807 */ 808 public boolean isInactive(); 809 810 /** 811 * Returns <code>true</code> if this journal article is incomplete. 812 * 813 * @return <code>true</code> if this journal article is incomplete; <code>false</code> otherwise 814 */ 815 public boolean isIncomplete(); 816 817 /** 818 * Returns <code>true</code> if this journal article is in the Recycle Bin. 819 * 820 * @return <code>true</code> if this journal article is in the Recycle Bin; <code>false</code> otherwise 821 */ 822 public boolean isInTrash(); 823 824 /** 825 * Returns <code>true</code> if this journal article is pending. 826 * 827 * @return <code>true</code> if this journal article is pending; <code>false</code> otherwise 828 */ 829 public boolean isPending(); 830 831 /** 832 * Returns <code>true</code> if this journal article is scheduled. 833 * 834 * @return <code>true</code> if this journal article is scheduled; <code>false</code> otherwise 835 */ 836 public boolean isScheduled(); 837 838 public boolean isNew(); 839 840 public void setNew(boolean n); 841 842 public boolean isCachedModel(); 843 844 public void setCachedModel(boolean cachedModel); 845 846 public boolean isEscapedModel(); 847 848 public Serializable getPrimaryKeyObj(); 849 850 public void setPrimaryKeyObj(Serializable primaryKeyObj); 851 852 public ExpandoBridge getExpandoBridge(); 853 854 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 855 856 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 857 throws LocaleException; 858 859 public Object clone(); 860 861 public int compareTo(JournalArticle journalArticle); 862 863 public int hashCode(); 864 865 public CacheModel<JournalArticle> toCacheModel(); 866 867 public JournalArticle toEscapedModel(); 868 869 public JournalArticle toUnescapedModel(); 870 871 public String toString(); 872 873 public String toXmlString(); 874 }