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