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