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