001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.blogs.model; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.AutoEscape; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.trash.TrashHandler; 022 import com.liferay.portal.model.BaseModel; 023 import com.liferay.portal.model.CacheModel; 024 import com.liferay.portal.model.ShardedModel; 025 import com.liferay.portal.model.StagedGroupedModel; 026 import com.liferay.portal.model.TrashedModel; 027 import com.liferay.portal.model.WorkflowedModel; 028 import com.liferay.portal.service.ServiceContext; 029 030 import com.liferay.portlet.expando.model.ExpandoBridge; 031 import com.liferay.portlet.trash.model.TrashEntry; 032 033 import java.io.Serializable; 034 035 import java.util.Date; 036 037 /** 038 * The base model interface for the BlogsEntry service. Represents a row in the "BlogsEntry" 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.blogs.model.impl.BlogsEntryModelImpl} 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.blogs.model.impl.BlogsEntryImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see BlogsEntry 046 * @see com.liferay.portlet.blogs.model.impl.BlogsEntryImpl 047 * @see com.liferay.portlet.blogs.model.impl.BlogsEntryModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface BlogsEntryModel extends BaseModel<BlogsEntry>, ShardedModel, 052 StagedGroupedModel, TrashedModel, WorkflowedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * Never modify or reference this interface directly. All methods that expect a blogs entry model instance should use the {@link BlogsEntry} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this blogs entry. 061 * 062 * @return the primary key of this blogs entry 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this blogs entry. 068 * 069 * @param primaryKey the primary key of this blogs entry 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this blogs entry. 075 * 076 * @return the uuid of this blogs entry 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this blogs entry. 084 * 085 * @param uuid the uuid of this blogs entry 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the entry ID of this blogs entry. 092 * 093 * @return the entry ID of this blogs entry 094 */ 095 public long getEntryId(); 096 097 /** 098 * Sets the entry ID of this blogs entry. 099 * 100 * @param entryId the entry ID of this blogs entry 101 */ 102 public void setEntryId(long entryId); 103 104 /** 105 * Returns the group ID of this blogs entry. 106 * 107 * @return the group ID of this blogs entry 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this blogs entry. 114 * 115 * @param groupId the group ID of this blogs entry 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this blogs entry. 122 * 123 * @return the company ID of this blogs entry 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this blogs entry. 130 * 131 * @param companyId the company ID of this blogs entry 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this blogs entry. 138 * 139 * @return the user ID of this blogs entry 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this blogs entry. 146 * 147 * @param userId the user ID of this blogs entry 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this blogs entry. 154 * 155 * @return the user uuid of this blogs entry 156 */ 157 @Override 158 public String getUserUuid(); 159 160 /** 161 * Sets the user uuid of this blogs entry. 162 * 163 * @param userUuid the user uuid of this blogs entry 164 */ 165 @Override 166 public void setUserUuid(String userUuid); 167 168 /** 169 * Returns the user name of this blogs entry. 170 * 171 * @return the user name of this blogs entry 172 */ 173 @AutoEscape 174 @Override 175 public String getUserName(); 176 177 /** 178 * Sets the user name of this blogs entry. 179 * 180 * @param userName the user name of this blogs entry 181 */ 182 @Override 183 public void setUserName(String userName); 184 185 /** 186 * Returns the create date of this blogs entry. 187 * 188 * @return the create date of this blogs entry 189 */ 190 @Override 191 public Date getCreateDate(); 192 193 /** 194 * Sets the create date of this blogs entry. 195 * 196 * @param createDate the create date of this blogs entry 197 */ 198 @Override 199 public void setCreateDate(Date createDate); 200 201 /** 202 * Returns the modified date of this blogs entry. 203 * 204 * @return the modified date of this blogs entry 205 */ 206 @Override 207 public Date getModifiedDate(); 208 209 /** 210 * Sets the modified date of this blogs entry. 211 * 212 * @param modifiedDate the modified date of this blogs entry 213 */ 214 @Override 215 public void setModifiedDate(Date modifiedDate); 216 217 /** 218 * Returns the title of this blogs entry. 219 * 220 * @return the title of this blogs entry 221 */ 222 @AutoEscape 223 public String getTitle(); 224 225 /** 226 * Sets the title of this blogs entry. 227 * 228 * @param title the title of this blogs entry 229 */ 230 public void setTitle(String title); 231 232 /** 233 * Returns the subtitle of this blogs entry. 234 * 235 * @return the subtitle of this blogs entry 236 */ 237 @AutoEscape 238 public String getSubtitle(); 239 240 /** 241 * Sets the subtitle of this blogs entry. 242 * 243 * @param subtitle the subtitle of this blogs entry 244 */ 245 public void setSubtitle(String subtitle); 246 247 /** 248 * Returns the url title of this blogs entry. 249 * 250 * @return the url title of this blogs entry 251 */ 252 @AutoEscape 253 public String getUrlTitle(); 254 255 /** 256 * Sets the url title of this blogs entry. 257 * 258 * @param urlTitle the url title of this blogs entry 259 */ 260 public void setUrlTitle(String urlTitle); 261 262 /** 263 * Returns the description of this blogs entry. 264 * 265 * @return the description of this blogs entry 266 */ 267 @AutoEscape 268 public String getDescription(); 269 270 /** 271 * Sets the description of this blogs entry. 272 * 273 * @param description the description of this blogs entry 274 */ 275 public void setDescription(String description); 276 277 /** 278 * Returns the content of this blogs entry. 279 * 280 * @return the content of this blogs entry 281 */ 282 @AutoEscape 283 public String getContent(); 284 285 /** 286 * Sets the content of this blogs entry. 287 * 288 * @param content the content of this blogs entry 289 */ 290 public void setContent(String content); 291 292 /** 293 * Returns the display date of this blogs entry. 294 * 295 * @return the display date of this blogs entry 296 */ 297 public Date getDisplayDate(); 298 299 /** 300 * Sets the display date of this blogs entry. 301 * 302 * @param displayDate the display date of this blogs entry 303 */ 304 public void setDisplayDate(Date displayDate); 305 306 /** 307 * Returns the allow pingbacks of this blogs entry. 308 * 309 * @return the allow pingbacks of this blogs entry 310 */ 311 public boolean getAllowPingbacks(); 312 313 /** 314 * Returns <code>true</code> if this blogs entry is allow pingbacks. 315 * 316 * @return <code>true</code> if this blogs entry is allow pingbacks; <code>false</code> otherwise 317 */ 318 public boolean isAllowPingbacks(); 319 320 /** 321 * Sets whether this blogs entry is allow pingbacks. 322 * 323 * @param allowPingbacks the allow pingbacks of this blogs entry 324 */ 325 public void setAllowPingbacks(boolean allowPingbacks); 326 327 /** 328 * Returns the allow trackbacks of this blogs entry. 329 * 330 * @return the allow trackbacks of this blogs entry 331 */ 332 public boolean getAllowTrackbacks(); 333 334 /** 335 * Returns <code>true</code> if this blogs entry is allow trackbacks. 336 * 337 * @return <code>true</code> if this blogs entry is allow trackbacks; <code>false</code> otherwise 338 */ 339 public boolean isAllowTrackbacks(); 340 341 /** 342 * Sets whether this blogs entry is allow trackbacks. 343 * 344 * @param allowTrackbacks the allow trackbacks of this blogs entry 345 */ 346 public void setAllowTrackbacks(boolean allowTrackbacks); 347 348 /** 349 * Returns the trackbacks of this blogs entry. 350 * 351 * @return the trackbacks of this blogs entry 352 */ 353 @AutoEscape 354 public String getTrackbacks(); 355 356 /** 357 * Sets the trackbacks of this blogs entry. 358 * 359 * @param trackbacks the trackbacks of this blogs entry 360 */ 361 public void setTrackbacks(String trackbacks); 362 363 /** 364 * Returns the cover image caption of this blogs entry. 365 * 366 * @return the cover image caption of this blogs entry 367 */ 368 @AutoEscape 369 public String getCoverImageCaption(); 370 371 /** 372 * Sets the cover image caption of this blogs entry. 373 * 374 * @param coverImageCaption the cover image caption of this blogs entry 375 */ 376 public void setCoverImageCaption(String coverImageCaption); 377 378 /** 379 * Returns the cover image file entry ID of this blogs entry. 380 * 381 * @return the cover image file entry ID of this blogs entry 382 */ 383 public long getCoverImageFileEntryId(); 384 385 /** 386 * Sets the cover image file entry ID of this blogs entry. 387 * 388 * @param coverImageFileEntryId the cover image file entry ID of this blogs entry 389 */ 390 public void setCoverImageFileEntryId(long coverImageFileEntryId); 391 392 /** 393 * Returns the cover image u r l of this blogs entry. 394 * 395 * @return the cover image u r l of this blogs entry 396 */ 397 @AutoEscape 398 public String getCoverImageURL(); 399 400 /** 401 * Sets the cover image u r l of this blogs entry. 402 * 403 * @param coverImageURL the cover image u r l of this blogs entry 404 */ 405 public void setCoverImageURL(String coverImageURL); 406 407 /** 408 * Returns the small image of this blogs entry. 409 * 410 * @return the small image of this blogs entry 411 */ 412 public boolean getSmallImage(); 413 414 /** 415 * Returns <code>true</code> if this blogs entry is small image. 416 * 417 * @return <code>true</code> if this blogs entry is small image; <code>false</code> otherwise 418 */ 419 public boolean isSmallImage(); 420 421 /** 422 * Sets whether this blogs entry is small image. 423 * 424 * @param smallImage the small image of this blogs entry 425 */ 426 public void setSmallImage(boolean smallImage); 427 428 /** 429 * Returns the small image file entry ID of this blogs entry. 430 * 431 * @return the small image file entry ID of this blogs entry 432 */ 433 public long getSmallImageFileEntryId(); 434 435 /** 436 * Sets the small image file entry ID of this blogs entry. 437 * 438 * @param smallImageFileEntryId the small image file entry ID of this blogs entry 439 */ 440 public void setSmallImageFileEntryId(long smallImageFileEntryId); 441 442 /** 443 * Returns the small image ID of this blogs entry. 444 * 445 * @return the small image ID of this blogs entry 446 */ 447 public long getSmallImageId(); 448 449 /** 450 * Sets the small image ID of this blogs entry. 451 * 452 * @param smallImageId the small image ID of this blogs entry 453 */ 454 public void setSmallImageId(long smallImageId); 455 456 /** 457 * Returns the small image u r l of this blogs entry. 458 * 459 * @return the small image u r l of this blogs entry 460 */ 461 @AutoEscape 462 public String getSmallImageURL(); 463 464 /** 465 * Sets the small image u r l of this blogs entry. 466 * 467 * @param smallImageURL the small image u r l of this blogs entry 468 */ 469 public void setSmallImageURL(String smallImageURL); 470 471 /** 472 * Returns the last publish date of this blogs entry. 473 * 474 * @return the last publish date of this blogs entry 475 */ 476 @Override 477 public Date getLastPublishDate(); 478 479 /** 480 * Sets the last publish date of this blogs entry. 481 * 482 * @param lastPublishDate the last publish date of this blogs entry 483 */ 484 @Override 485 public void setLastPublishDate(Date lastPublishDate); 486 487 /** 488 * Returns the status of this blogs entry. 489 * 490 * @return the status of this blogs entry 491 */ 492 @Override 493 public int getStatus(); 494 495 /** 496 * Sets the status of this blogs entry. 497 * 498 * @param status the status of this blogs entry 499 */ 500 @Override 501 public void setStatus(int status); 502 503 /** 504 * Returns the status by user ID of this blogs entry. 505 * 506 * @return the status by user ID of this blogs entry 507 */ 508 @Override 509 public long getStatusByUserId(); 510 511 /** 512 * Sets the status by user ID of this blogs entry. 513 * 514 * @param statusByUserId the status by user ID of this blogs entry 515 */ 516 @Override 517 public void setStatusByUserId(long statusByUserId); 518 519 /** 520 * Returns the status by user uuid of this blogs entry. 521 * 522 * @return the status by user uuid of this blogs entry 523 */ 524 @Override 525 public String getStatusByUserUuid(); 526 527 /** 528 * Sets the status by user uuid of this blogs entry. 529 * 530 * @param statusByUserUuid the status by user uuid of this blogs entry 531 */ 532 @Override 533 public void setStatusByUserUuid(String statusByUserUuid); 534 535 /** 536 * Returns the status by user name of this blogs entry. 537 * 538 * @return the status by user name of this blogs entry 539 */ 540 @AutoEscape 541 @Override 542 public String getStatusByUserName(); 543 544 /** 545 * Sets the status by user name of this blogs entry. 546 * 547 * @param statusByUserName the status by user name of this blogs entry 548 */ 549 @Override 550 public void setStatusByUserName(String statusByUserName); 551 552 /** 553 * Returns the status date of this blogs entry. 554 * 555 * @return the status date of this blogs entry 556 */ 557 @Override 558 public Date getStatusDate(); 559 560 /** 561 * Sets the status date of this blogs entry. 562 * 563 * @param statusDate the status date of this blogs entry 564 */ 565 @Override 566 public void setStatusDate(Date statusDate); 567 568 /** 569 * Returns the trash entry created when this blogs entry was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this blogs entry. 570 * 571 * @return the trash entry created when this blogs entry was moved to the Recycle Bin 572 */ 573 @Override 574 public TrashEntry getTrashEntry() throws PortalException; 575 576 /** 577 * Returns the class primary key of the trash entry for this blogs entry. 578 * 579 * @return the class primary key of the trash entry for this blogs entry 580 */ 581 @Override 582 public long getTrashEntryClassPK(); 583 584 /** 585 * Returns the trash handler for this blogs entry. 586 * 587 * @return the trash handler for this blogs entry 588 */ 589 @Override 590 public TrashHandler getTrashHandler(); 591 592 /** 593 * Returns <code>true</code> if this blogs entry is in the Recycle Bin. 594 * 595 * @return <code>true</code> if this blogs entry is in the Recycle Bin; <code>false</code> otherwise 596 */ 597 @Override 598 public boolean isInTrash(); 599 600 /** 601 * Returns <code>true</code> if the parent of this blogs entry is in the Recycle Bin. 602 * 603 * @return <code>true</code> if the parent of this blogs entry is in the Recycle Bin; <code>false</code> otherwise 604 */ 605 @Override 606 public boolean isInTrashContainer(); 607 608 @Override 609 public boolean isInTrashExplicitly(); 610 611 @Override 612 public boolean isInTrashImplicitly(); 613 614 /** 615 * Returns <code>true</code> if this blogs entry is approved. 616 * 617 * @return <code>true</code> if this blogs entry is approved; <code>false</code> otherwise 618 */ 619 @Override 620 public boolean isApproved(); 621 622 /** 623 * Returns <code>true</code> if this blogs entry is denied. 624 * 625 * @return <code>true</code> if this blogs entry is denied; <code>false</code> otherwise 626 */ 627 @Override 628 public boolean isDenied(); 629 630 /** 631 * Returns <code>true</code> if this blogs entry is a draft. 632 * 633 * @return <code>true</code> if this blogs entry is a draft; <code>false</code> otherwise 634 */ 635 @Override 636 public boolean isDraft(); 637 638 /** 639 * Returns <code>true</code> if this blogs entry is expired. 640 * 641 * @return <code>true</code> if this blogs entry is expired; <code>false</code> otherwise 642 */ 643 @Override 644 public boolean isExpired(); 645 646 /** 647 * Returns <code>true</code> if this blogs entry is inactive. 648 * 649 * @return <code>true</code> if this blogs entry is inactive; <code>false</code> otherwise 650 */ 651 @Override 652 public boolean isInactive(); 653 654 /** 655 * Returns <code>true</code> if this blogs entry is incomplete. 656 * 657 * @return <code>true</code> if this blogs entry is incomplete; <code>false</code> otherwise 658 */ 659 @Override 660 public boolean isIncomplete(); 661 662 /** 663 * Returns <code>true</code> if this blogs entry is pending. 664 * 665 * @return <code>true</code> if this blogs entry is pending; <code>false</code> otherwise 666 */ 667 @Override 668 public boolean isPending(); 669 670 /** 671 * Returns <code>true</code> if this blogs entry is scheduled. 672 * 673 * @return <code>true</code> if this blogs entry is scheduled; <code>false</code> otherwise 674 */ 675 @Override 676 public boolean isScheduled(); 677 678 @Override 679 public boolean isNew(); 680 681 @Override 682 public void setNew(boolean n); 683 684 @Override 685 public boolean isCachedModel(); 686 687 @Override 688 public void setCachedModel(boolean cachedModel); 689 690 @Override 691 public boolean isEscapedModel(); 692 693 @Override 694 public Serializable getPrimaryKeyObj(); 695 696 @Override 697 public void setPrimaryKeyObj(Serializable primaryKeyObj); 698 699 @Override 700 public ExpandoBridge getExpandoBridge(); 701 702 @Override 703 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 704 705 @Override 706 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 707 708 @Override 709 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 710 711 @Override 712 public Object clone(); 713 714 @Override 715 public int compareTo(com.liferay.portlet.blogs.model.BlogsEntry blogsEntry); 716 717 @Override 718 public int hashCode(); 719 720 @Override 721 public CacheModel<com.liferay.portlet.blogs.model.BlogsEntry> toCacheModel(); 722 723 @Override 724 public com.liferay.portlet.blogs.model.BlogsEntry toEscapedModel(); 725 726 @Override 727 public com.liferay.portlet.blogs.model.BlogsEntry toUnescapedModel(); 728 729 @Override 730 public String toString(); 731 732 @Override 733 public String toXmlString(); 734 }