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