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