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.messageboards.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.ContainerModel; 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 MBThread service. Represents a row in the "MBThread" 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.messageboards.model.impl.MBThreadModelImpl} 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.messageboards.model.impl.MBThreadImpl}. 042 * </p> 043 * 044 * @author Brian Wing Shun Chan 045 * @see MBThread 046 * @see com.liferay.portlet.messageboards.model.impl.MBThreadImpl 047 * @see com.liferay.portlet.messageboards.model.impl.MBThreadModelImpl 048 * @generated 049 */ 050 @ProviderType 051 public interface MBThreadModel extends BaseModel<MBThread>, ContainerModel, 052 StagedGroupedModel, TrashedModel, WorkflowedModel { 053 /* 054 * NOTE FOR DEVELOPERS: 055 * 056 * Never modify or reference this interface directly. All methods that expect a message boards thread model instance should use the {@link MBThread} interface instead. 057 */ 058 059 /** 060 * Returns the primary key of this message boards thread. 061 * 062 * @return the primary key of this message boards thread 063 */ 064 public long getPrimaryKey(); 065 066 /** 067 * Sets the primary key of this message boards thread. 068 * 069 * @param primaryKey the primary key of this message boards thread 070 */ 071 public void setPrimaryKey(long primaryKey); 072 073 /** 074 * Returns the uuid of this message boards thread. 075 * 076 * @return the uuid of this message boards thread 077 */ 078 @AutoEscape 079 @Override 080 public String getUuid(); 081 082 /** 083 * Sets the uuid of this message boards thread. 084 * 085 * @param uuid the uuid of this message boards thread 086 */ 087 @Override 088 public void setUuid(String uuid); 089 090 /** 091 * Returns the thread ID of this message boards thread. 092 * 093 * @return the thread ID of this message boards thread 094 */ 095 public long getThreadId(); 096 097 /** 098 * Sets the thread ID of this message boards thread. 099 * 100 * @param threadId the thread ID of this message boards thread 101 */ 102 public void setThreadId(long threadId); 103 104 /** 105 * Returns the group ID of this message boards thread. 106 * 107 * @return the group ID of this message boards thread 108 */ 109 @Override 110 public long getGroupId(); 111 112 /** 113 * Sets the group ID of this message boards thread. 114 * 115 * @param groupId the group ID of this message boards thread 116 */ 117 @Override 118 public void setGroupId(long groupId); 119 120 /** 121 * Returns the company ID of this message boards thread. 122 * 123 * @return the company ID of this message boards thread 124 */ 125 @Override 126 public long getCompanyId(); 127 128 /** 129 * Sets the company ID of this message boards thread. 130 * 131 * @param companyId the company ID of this message boards thread 132 */ 133 @Override 134 public void setCompanyId(long companyId); 135 136 /** 137 * Returns the user ID of this message boards thread. 138 * 139 * @return the user ID of this message boards thread 140 */ 141 @Override 142 public long getUserId(); 143 144 /** 145 * Sets the user ID of this message boards thread. 146 * 147 * @param userId the user ID of this message boards thread 148 */ 149 @Override 150 public void setUserId(long userId); 151 152 /** 153 * Returns the user uuid of this message boards thread. 154 * 155 * @return the user uuid of this message boards thread 156 */ 157 @Override 158 public String getUserUuid(); 159 160 /** 161 * Sets the user uuid of this message boards thread. 162 * 163 * @param userUuid the user uuid of this message boards thread 164 */ 165 @Override 166 public void setUserUuid(String userUuid); 167 168 /** 169 * Returns the user name of this message boards thread. 170 * 171 * @return the user name of this message boards thread 172 */ 173 @AutoEscape 174 @Override 175 public String getUserName(); 176 177 /** 178 * Sets the user name of this message boards thread. 179 * 180 * @param userName the user name of this message boards thread 181 */ 182 @Override 183 public void setUserName(String userName); 184 185 /** 186 * Returns the create date of this message boards thread. 187 * 188 * @return the create date of this message boards thread 189 */ 190 @Override 191 public Date getCreateDate(); 192 193 /** 194 * Sets the create date of this message boards thread. 195 * 196 * @param createDate the create date of this message boards thread 197 */ 198 @Override 199 public void setCreateDate(Date createDate); 200 201 /** 202 * Returns the modified date of this message boards thread. 203 * 204 * @return the modified date of this message boards thread 205 */ 206 @Override 207 public Date getModifiedDate(); 208 209 /** 210 * Sets the modified date of this message boards thread. 211 * 212 * @param modifiedDate the modified date of this message boards thread 213 */ 214 @Override 215 public void setModifiedDate(Date modifiedDate); 216 217 /** 218 * Returns the category ID of this message boards thread. 219 * 220 * @return the category ID of this message boards thread 221 */ 222 public long getCategoryId(); 223 224 /** 225 * Sets the category ID of this message boards thread. 226 * 227 * @param categoryId the category ID of this message boards thread 228 */ 229 public void setCategoryId(long categoryId); 230 231 /** 232 * Returns the root message ID of this message boards thread. 233 * 234 * @return the root message ID of this message boards thread 235 */ 236 public long getRootMessageId(); 237 238 /** 239 * Sets the root message ID of this message boards thread. 240 * 241 * @param rootMessageId the root message ID of this message boards thread 242 */ 243 public void setRootMessageId(long rootMessageId); 244 245 /** 246 * Returns the root message user ID of this message boards thread. 247 * 248 * @return the root message user ID of this message boards thread 249 */ 250 public long getRootMessageUserId(); 251 252 /** 253 * Sets the root message user ID of this message boards thread. 254 * 255 * @param rootMessageUserId the root message user ID of this message boards thread 256 */ 257 public void setRootMessageUserId(long rootMessageUserId); 258 259 /** 260 * Returns the root message user uuid of this message boards thread. 261 * 262 * @return the root message user uuid of this message boards thread 263 */ 264 public String getRootMessageUserUuid(); 265 266 /** 267 * Sets the root message user uuid of this message boards thread. 268 * 269 * @param rootMessageUserUuid the root message user uuid of this message boards thread 270 */ 271 public void setRootMessageUserUuid(String rootMessageUserUuid); 272 273 /** 274 * Returns the message count of this message boards thread. 275 * 276 * @return the message count of this message boards thread 277 */ 278 public int getMessageCount(); 279 280 /** 281 * Sets the message count of this message boards thread. 282 * 283 * @param messageCount the message count of this message boards thread 284 */ 285 public void setMessageCount(int messageCount); 286 287 /** 288 * Returns the view count of this message boards thread. 289 * 290 * @return the view count of this message boards thread 291 */ 292 public int getViewCount(); 293 294 /** 295 * Sets the view count of this message boards thread. 296 * 297 * @param viewCount the view count of this message boards thread 298 */ 299 public void setViewCount(int viewCount); 300 301 /** 302 * Returns the last post by user ID of this message boards thread. 303 * 304 * @return the last post by user ID of this message boards thread 305 */ 306 public long getLastPostByUserId(); 307 308 /** 309 * Sets the last post by user ID of this message boards thread. 310 * 311 * @param lastPostByUserId the last post by user ID of this message boards thread 312 */ 313 public void setLastPostByUserId(long lastPostByUserId); 314 315 /** 316 * Returns the last post by user uuid of this message boards thread. 317 * 318 * @return the last post by user uuid of this message boards thread 319 */ 320 public String getLastPostByUserUuid(); 321 322 /** 323 * Sets the last post by user uuid of this message boards thread. 324 * 325 * @param lastPostByUserUuid the last post by user uuid of this message boards thread 326 */ 327 public void setLastPostByUserUuid(String lastPostByUserUuid); 328 329 /** 330 * Returns the last post date of this message boards thread. 331 * 332 * @return the last post date of this message boards thread 333 */ 334 public Date getLastPostDate(); 335 336 /** 337 * Sets the last post date of this message boards thread. 338 * 339 * @param lastPostDate the last post date of this message boards thread 340 */ 341 public void setLastPostDate(Date lastPostDate); 342 343 /** 344 * Returns the priority of this message boards thread. 345 * 346 * @return the priority of this message boards thread 347 */ 348 public double getPriority(); 349 350 /** 351 * Sets the priority of this message boards thread. 352 * 353 * @param priority the priority of this message boards thread 354 */ 355 public void setPriority(double priority); 356 357 /** 358 * Returns the question of this message boards thread. 359 * 360 * @return the question of this message boards thread 361 */ 362 public boolean getQuestion(); 363 364 /** 365 * Returns <code>true</code> if this message boards thread is question. 366 * 367 * @return <code>true</code> if this message boards thread is question; <code>false</code> otherwise 368 */ 369 public boolean isQuestion(); 370 371 /** 372 * Sets whether this message boards thread is question. 373 * 374 * @param question the question of this message boards thread 375 */ 376 public void setQuestion(boolean question); 377 378 /** 379 * Returns the last publish date of this message boards thread. 380 * 381 * @return the last publish date of this message boards thread 382 */ 383 @Override 384 public Date getLastPublishDate(); 385 386 /** 387 * Sets the last publish date of this message boards thread. 388 * 389 * @param lastPublishDate the last publish date of this message boards thread 390 */ 391 @Override 392 public void setLastPublishDate(Date lastPublishDate); 393 394 /** 395 * Returns the status of this message boards thread. 396 * 397 * @return the status of this message boards thread 398 */ 399 @Override 400 public int getStatus(); 401 402 /** 403 * Sets the status of this message boards thread. 404 * 405 * @param status the status of this message boards thread 406 */ 407 @Override 408 public void setStatus(int status); 409 410 /** 411 * Returns the status by user ID of this message boards thread. 412 * 413 * @return the status by user ID of this message boards thread 414 */ 415 @Override 416 public long getStatusByUserId(); 417 418 /** 419 * Sets the status by user ID of this message boards thread. 420 * 421 * @param statusByUserId the status by user ID of this message boards thread 422 */ 423 @Override 424 public void setStatusByUserId(long statusByUserId); 425 426 /** 427 * Returns the status by user uuid of this message boards thread. 428 * 429 * @return the status by user uuid of this message boards thread 430 */ 431 @Override 432 public String getStatusByUserUuid(); 433 434 /** 435 * Sets the status by user uuid of this message boards thread. 436 * 437 * @param statusByUserUuid the status by user uuid of this message boards thread 438 */ 439 @Override 440 public void setStatusByUserUuid(String statusByUserUuid); 441 442 /** 443 * Returns the status by user name of this message boards thread. 444 * 445 * @return the status by user name of this message boards thread 446 */ 447 @AutoEscape 448 @Override 449 public String getStatusByUserName(); 450 451 /** 452 * Sets the status by user name of this message boards thread. 453 * 454 * @param statusByUserName the status by user name of this message boards thread 455 */ 456 @Override 457 public void setStatusByUserName(String statusByUserName); 458 459 /** 460 * Returns the status date of this message boards thread. 461 * 462 * @return the status date of this message boards thread 463 */ 464 @Override 465 public Date getStatusDate(); 466 467 /** 468 * Sets the status date of this message boards thread. 469 * 470 * @param statusDate the status date of this message boards thread 471 */ 472 @Override 473 public void setStatusDate(Date statusDate); 474 475 /** 476 * Returns the trash entry created when this message boards thread was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this message boards thread. 477 * 478 * @return the trash entry created when this message boards thread was moved to the Recycle Bin 479 */ 480 @Override 481 public TrashEntry getTrashEntry() throws PortalException; 482 483 /** 484 * Returns the class primary key of the trash entry for this message boards thread. 485 * 486 * @return the class primary key of the trash entry for this message boards thread 487 */ 488 @Override 489 public long getTrashEntryClassPK(); 490 491 /** 492 * Returns the trash handler for this message boards thread. 493 * 494 * @return the trash handler for this message boards thread 495 */ 496 @Override 497 public TrashHandler getTrashHandler(); 498 499 /** 500 * Returns <code>true</code> if this message boards thread is in the Recycle Bin. 501 * 502 * @return <code>true</code> if this message boards thread is in the Recycle Bin; <code>false</code> otherwise 503 */ 504 @Override 505 public boolean isInTrash(); 506 507 /** 508 * Returns <code>true</code> if the parent of this message boards thread is in the Recycle Bin. 509 * 510 * @return <code>true</code> if the parent of this message boards thread is in the Recycle Bin; <code>false</code> otherwise 511 */ 512 @Override 513 public boolean isInTrashContainer(); 514 515 @Override 516 public boolean isInTrashExplicitly(); 517 518 @Override 519 public boolean isInTrashImplicitly(); 520 521 /** 522 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 523 */ 524 @Deprecated 525 @Override 526 public boolean getApproved(); 527 528 /** 529 * Returns <code>true</code> if this message boards thread is approved. 530 * 531 * @return <code>true</code> if this message boards thread is approved; <code>false</code> otherwise 532 */ 533 @Override 534 public boolean isApproved(); 535 536 /** 537 * Returns <code>true</code> if this message boards thread is denied. 538 * 539 * @return <code>true</code> if this message boards thread is denied; <code>false</code> otherwise 540 */ 541 @Override 542 public boolean isDenied(); 543 544 /** 545 * Returns <code>true</code> if this message boards thread is a draft. 546 * 547 * @return <code>true</code> if this message boards thread is a draft; <code>false</code> otherwise 548 */ 549 @Override 550 public boolean isDraft(); 551 552 /** 553 * Returns <code>true</code> if this message boards thread is expired. 554 * 555 * @return <code>true</code> if this message boards thread is expired; <code>false</code> otherwise 556 */ 557 @Override 558 public boolean isExpired(); 559 560 /** 561 * Returns <code>true</code> if this message boards thread is inactive. 562 * 563 * @return <code>true</code> if this message boards thread is inactive; <code>false</code> otherwise 564 */ 565 @Override 566 public boolean isInactive(); 567 568 /** 569 * Returns <code>true</code> if this message boards thread is incomplete. 570 * 571 * @return <code>true</code> if this message boards thread is incomplete; <code>false</code> otherwise 572 */ 573 @Override 574 public boolean isIncomplete(); 575 576 /** 577 * Returns <code>true</code> if this message boards thread is pending. 578 * 579 * @return <code>true</code> if this message boards thread is pending; <code>false</code> otherwise 580 */ 581 @Override 582 public boolean isPending(); 583 584 /** 585 * Returns <code>true</code> if this message boards thread is scheduled. 586 * 587 * @return <code>true</code> if this message boards thread is scheduled; <code>false</code> otherwise 588 */ 589 @Override 590 public boolean isScheduled(); 591 592 /** 593 * Returns the container model ID of this message boards thread. 594 * 595 * @return the container model ID of this message boards thread 596 */ 597 @Override 598 public long getContainerModelId(); 599 600 /** 601 * Sets the container model ID of this message boards thread. 602 * 603 * @param containerModelId the container model ID of this message boards thread 604 */ 605 @Override 606 public void setContainerModelId(long containerModelId); 607 608 /** 609 * Returns the container name of this message boards thread. 610 * 611 * @return the container name of this message boards thread 612 */ 613 @Override 614 public String getContainerModelName(); 615 616 /** 617 * Returns the parent container model ID of this message boards thread. 618 * 619 * @return the parent container model ID of this message boards thread 620 */ 621 @Override 622 public long getParentContainerModelId(); 623 624 /** 625 * Sets the parent container model ID of this message boards thread. 626 * 627 * @param parentContainerModelId the parent container model ID of this message boards thread 628 */ 629 @Override 630 public void setParentContainerModelId(long parentContainerModelId); 631 632 @Override 633 public boolean isNew(); 634 635 @Override 636 public void setNew(boolean n); 637 638 @Override 639 public boolean isCachedModel(); 640 641 @Override 642 public void setCachedModel(boolean cachedModel); 643 644 @Override 645 public boolean isEscapedModel(); 646 647 @Override 648 public Serializable getPrimaryKeyObj(); 649 650 @Override 651 public void setPrimaryKeyObj(Serializable primaryKeyObj); 652 653 @Override 654 public ExpandoBridge getExpandoBridge(); 655 656 @Override 657 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 658 659 @Override 660 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 661 662 @Override 663 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 664 665 @Override 666 public Object clone(); 667 668 @Override 669 public int compareTo( 670 com.liferay.portlet.messageboards.model.MBThread mbThread); 671 672 @Override 673 public int hashCode(); 674 675 @Override 676 public CacheModel<com.liferay.portlet.messageboards.model.MBThread> toCacheModel(); 677 678 @Override 679 public com.liferay.portlet.messageboards.model.MBThread toEscapedModel(); 680 681 @Override 682 public com.liferay.portlet.messageboards.model.MBThread toUnescapedModel(); 683 684 @Override 685 public String toString(); 686 687 @Override 688 public String toXmlString(); 689 }