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