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.AttachedModel; 024 import com.liferay.portal.model.BaseModel; 025 import com.liferay.portal.model.CacheModel; 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 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 * @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 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 status of this message-boards message. 441 * 442 * @return the status of this message-boards message 443 */ 444 @Override 445 public int getStatus(); 446 447 /** 448 * Sets the status of this message-boards message. 449 * 450 * @param status the status of this message-boards message 451 */ 452 @Override 453 public void setStatus(int status); 454 455 /** 456 * Returns the status by user ID of this message-boards message. 457 * 458 * @return the status by user ID of this message-boards message 459 */ 460 @Override 461 public long getStatusByUserId(); 462 463 /** 464 * Sets the status by user ID of this message-boards message. 465 * 466 * @param statusByUserId the status by user ID of this message-boards message 467 */ 468 @Override 469 public void setStatusByUserId(long statusByUserId); 470 471 /** 472 * Returns the status by user uuid of this message-boards message. 473 * 474 * @return the status by user uuid of this message-boards message 475 * @throws SystemException if a system exception occurred 476 */ 477 @Override 478 public String getStatusByUserUuid() throws SystemException; 479 480 /** 481 * Sets the status by user uuid of this message-boards message. 482 * 483 * @param statusByUserUuid the status by user uuid of this message-boards message 484 */ 485 @Override 486 public void setStatusByUserUuid(String statusByUserUuid); 487 488 /** 489 * Returns the status by user name of this message-boards message. 490 * 491 * @return the status by user name of this message-boards message 492 */ 493 @AutoEscape 494 @Override 495 public String getStatusByUserName(); 496 497 /** 498 * Sets the status by user name of this message-boards message. 499 * 500 * @param statusByUserName the status by user name of this message-boards message 501 */ 502 @Override 503 public void setStatusByUserName(String statusByUserName); 504 505 /** 506 * Returns the status date of this message-boards message. 507 * 508 * @return the status date of this message-boards message 509 */ 510 @Override 511 public Date getStatusDate(); 512 513 /** 514 * Sets the status date of this message-boards message. 515 * 516 * @param statusDate the status date of this message-boards message 517 */ 518 @Override 519 public void setStatusDate(Date statusDate); 520 521 /** 522 * 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. 523 * 524 * @return the trash entry created when this message-boards message was moved to the Recycle Bin 525 * @throws SystemException if a system exception occurred 526 */ 527 @Override 528 public TrashEntry getTrashEntry() throws PortalException, SystemException; 529 530 /** 531 * Returns the class primary key of the trash entry for this message-boards message. 532 * 533 * @return the class primary key of the trash entry for this message-boards message 534 */ 535 @Override 536 public long getTrashEntryClassPK(); 537 538 /** 539 * Returns the trash handler for this message-boards message. 540 * 541 * @return the trash handler for this message-boards message 542 */ 543 @Override 544 public TrashHandler getTrashHandler(); 545 546 /** 547 * Returns <code>true</code> if this message-boards message is in the Recycle Bin. 548 * 549 * @return <code>true</code> if this message-boards message is in the Recycle Bin; <code>false</code> otherwise 550 */ 551 @Override 552 public boolean isInTrash(); 553 554 /** 555 * Returns <code>true</code> if the parent of this message-boards message is in the Recycle Bin. 556 * 557 * @return <code>true</code> if the parent of this message-boards message is in the Recycle Bin; <code>false</code> otherwise 558 * @throws SystemException if a system exception occurred 559 */ 560 @Override 561 public boolean isInTrashContainer(); 562 563 /** 564 * @deprecated As of 6.1.0, replaced by {@link #isApproved()} 565 */ 566 @Override 567 public boolean getApproved(); 568 569 /** 570 * Returns <code>true</code> if this message-boards message is approved. 571 * 572 * @return <code>true</code> if this message-boards message is approved; <code>false</code> otherwise 573 */ 574 @Override 575 public boolean isApproved(); 576 577 /** 578 * Returns <code>true</code> if this message-boards message is denied. 579 * 580 * @return <code>true</code> if this message-boards message is denied; <code>false</code> otherwise 581 */ 582 @Override 583 public boolean isDenied(); 584 585 /** 586 * Returns <code>true</code> if this message-boards message is a draft. 587 * 588 * @return <code>true</code> if this message-boards message is a draft; <code>false</code> otherwise 589 */ 590 @Override 591 public boolean isDraft(); 592 593 /** 594 * Returns <code>true</code> if this message-boards message is expired. 595 * 596 * @return <code>true</code> if this message-boards message is expired; <code>false</code> otherwise 597 */ 598 @Override 599 public boolean isExpired(); 600 601 /** 602 * Returns <code>true</code> if this message-boards message is inactive. 603 * 604 * @return <code>true</code> if this message-boards message is inactive; <code>false</code> otherwise 605 */ 606 @Override 607 public boolean isInactive(); 608 609 /** 610 * Returns <code>true</code> if this message-boards message is incomplete. 611 * 612 * @return <code>true</code> if this message-boards message is incomplete; <code>false</code> otherwise 613 */ 614 @Override 615 public boolean isIncomplete(); 616 617 /** 618 * Returns <code>true</code> if this message-boards message is pending. 619 * 620 * @return <code>true</code> if this message-boards message is pending; <code>false</code> otherwise 621 */ 622 @Override 623 public boolean isPending(); 624 625 /** 626 * Returns <code>true</code> if this message-boards message is scheduled. 627 * 628 * @return <code>true</code> if this message-boards message is scheduled; <code>false</code> otherwise 629 */ 630 @Override 631 public boolean isScheduled(); 632 633 @Override 634 public boolean isNew(); 635 636 @Override 637 public void setNew(boolean n); 638 639 @Override 640 public boolean isCachedModel(); 641 642 @Override 643 public void setCachedModel(boolean cachedModel); 644 645 @Override 646 public boolean isEscapedModel(); 647 648 @Override 649 public Serializable getPrimaryKeyObj(); 650 651 @Override 652 public void setPrimaryKeyObj(Serializable primaryKeyObj); 653 654 @Override 655 public ExpandoBridge getExpandoBridge(); 656 657 @Override 658 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 659 660 @Override 661 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 662 663 @Override 664 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 665 666 @Override 667 public Object clone(); 668 669 @Override 670 public int compareTo(MBMessage mbMessage); 671 672 @Override 673 public int hashCode(); 674 675 @Override 676 public CacheModel<MBMessage> toCacheModel(); 677 678 @Override 679 public MBMessage toEscapedModel(); 680 681 @Override 682 public MBMessage toUnescapedModel(); 683 684 @Override 685 public String toString(); 686 687 @Override 688 public String toXmlString(); 689 }