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