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