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