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.GroupedModel; 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 GroupedModel, 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 public String getUuid(); 074 075 /** 076 * Sets the uuid of this message-boards message. 077 * 078 * @param uuid the uuid of this message-boards message 079 */ 080 public void setUuid(String uuid); 081 082 /** 083 * Returns the message ID of this message-boards message. 084 * 085 * @return the message ID of this message-boards message 086 */ 087 public long getMessageId(); 088 089 /** 090 * Sets the message ID of this message-boards message. 091 * 092 * @param messageId the message ID of this message-boards message 093 */ 094 public void setMessageId(long messageId); 095 096 /** 097 * Returns the group ID of this message-boards message. 098 * 099 * @return the group ID of this message-boards message 100 */ 101 public long getGroupId(); 102 103 /** 104 * Sets the group ID of this message-boards message. 105 * 106 * @param groupId the group ID of this message-boards message 107 */ 108 public void setGroupId(long groupId); 109 110 /** 111 * Returns the company ID of this message-boards message. 112 * 113 * @return the company ID of this message-boards message 114 */ 115 public long getCompanyId(); 116 117 /** 118 * Sets the company ID of this message-boards message. 119 * 120 * @param companyId the company ID of this message-boards message 121 */ 122 public void setCompanyId(long companyId); 123 124 /** 125 * Returns the user ID of this message-boards message. 126 * 127 * @return the user ID of this message-boards message 128 */ 129 public long getUserId(); 130 131 /** 132 * Sets the user ID of this message-boards message. 133 * 134 * @param userId the user ID of this message-boards message 135 */ 136 public void setUserId(long userId); 137 138 /** 139 * Returns the user uuid of this message-boards message. 140 * 141 * @return the user uuid of this message-boards message 142 * @throws SystemException if a system exception occurred 143 */ 144 public String getUserUuid() throws SystemException; 145 146 /** 147 * Sets the user uuid of this message-boards message. 148 * 149 * @param userUuid the user uuid of this message-boards message 150 */ 151 public void setUserUuid(String userUuid); 152 153 /** 154 * Returns the user name of this message-boards message. 155 * 156 * @return the user name of this message-boards message 157 */ 158 @AutoEscape 159 public String getUserName(); 160 161 /** 162 * Sets the user name of this message-boards message. 163 * 164 * @param userName the user name of this message-boards message 165 */ 166 public void setUserName(String userName); 167 168 /** 169 * Returns the create date of this message-boards message. 170 * 171 * @return the create date of this message-boards message 172 */ 173 public Date getCreateDate(); 174 175 /** 176 * Sets the create date of this message-boards message. 177 * 178 * @param createDate the create date of this message-boards message 179 */ 180 public void setCreateDate(Date createDate); 181 182 /** 183 * Returns the modified date of this message-boards message. 184 * 185 * @return the modified date of this message-boards message 186 */ 187 public Date getModifiedDate(); 188 189 /** 190 * Sets the modified date of this message-boards message. 191 * 192 * @param modifiedDate the modified date of this message-boards message 193 */ 194 public void setModifiedDate(Date modifiedDate); 195 196 /** 197 * Returns the fully qualified class name of this message-boards message. 198 * 199 * @return the fully qualified class name of this message-boards message 200 */ 201 public String getClassName(); 202 203 public void setClassName(String className); 204 205 /** 206 * Returns the class name ID of this message-boards message. 207 * 208 * @return the class name ID of this message-boards message 209 */ 210 public long getClassNameId(); 211 212 /** 213 * Sets the class name ID of this message-boards message. 214 * 215 * @param classNameId the class name ID of this message-boards message 216 */ 217 public void setClassNameId(long classNameId); 218 219 /** 220 * Returns the class p k of this message-boards message. 221 * 222 * @return the class p k of this message-boards message 223 */ 224 public long getClassPK(); 225 226 /** 227 * Sets the class p k of this message-boards message. 228 * 229 * @param classPK the class p k of this message-boards message 230 */ 231 public void setClassPK(long classPK); 232 233 /** 234 * Returns the category ID of this message-boards message. 235 * 236 * @return the category ID of this message-boards message 237 */ 238 public long getCategoryId(); 239 240 /** 241 * Sets the category ID of this message-boards message. 242 * 243 * @param categoryId the category ID of this message-boards message 244 */ 245 public void setCategoryId(long categoryId); 246 247 /** 248 * Returns the thread ID of this message-boards message. 249 * 250 * @return the thread ID of this message-boards message 251 */ 252 public long getThreadId(); 253 254 /** 255 * Sets the thread ID of this message-boards message. 256 * 257 * @param threadId the thread ID of this message-boards message 258 */ 259 public void setThreadId(long threadId); 260 261 /** 262 * Returns the root message ID of this message-boards message. 263 * 264 * @return the root message ID of this message-boards message 265 */ 266 public long getRootMessageId(); 267 268 /** 269 * Sets the root message ID of this message-boards message. 270 * 271 * @param rootMessageId the root message ID of this message-boards message 272 */ 273 public void setRootMessageId(long rootMessageId); 274 275 /** 276 * Returns the parent message ID of this message-boards message. 277 * 278 * @return the parent message ID of this message-boards message 279 */ 280 public long getParentMessageId(); 281 282 /** 283 * Sets the parent message ID of this message-boards message. 284 * 285 * @param parentMessageId the parent message ID of this message-boards message 286 */ 287 public void setParentMessageId(long parentMessageId); 288 289 /** 290 * Returns the subject of this message-boards message. 291 * 292 * @return the subject of this message-boards message 293 */ 294 @AutoEscape 295 public String getSubject(); 296 297 /** 298 * Sets the subject of this message-boards message. 299 * 300 * @param subject the subject of this message-boards message 301 */ 302 public void setSubject(String subject); 303 304 /** 305 * Returns the body of this message-boards message. 306 * 307 * @return the body of this message-boards message 308 */ 309 @AutoEscape 310 public String getBody(); 311 312 /** 313 * Sets the body of this message-boards message. 314 * 315 * @param body the body of this message-boards message 316 */ 317 public void setBody(String body); 318 319 /** 320 * Returns the format of this message-boards message. 321 * 322 * @return the format of this message-boards message 323 */ 324 @AutoEscape 325 public String getFormat(); 326 327 /** 328 * Sets the format of this message-boards message. 329 * 330 * @param format the format of this message-boards message 331 */ 332 public void setFormat(String format); 333 334 /** 335 * Returns the attachments of this message-boards message. 336 * 337 * @return the attachments of this message-boards message 338 */ 339 public boolean getAttachments(); 340 341 /** 342 * Returns <code>true</code> if this message-boards message is attachments. 343 * 344 * @return <code>true</code> if this message-boards message is attachments; <code>false</code> otherwise 345 */ 346 public boolean isAttachments(); 347 348 /** 349 * Sets whether this message-boards message is attachments. 350 * 351 * @param attachments the attachments of this message-boards message 352 */ 353 public void setAttachments(boolean attachments); 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 public int getStatus(); 438 439 /** 440 * Sets the status of this message-boards message. 441 * 442 * @param status the status of this message-boards message 443 */ 444 public void setStatus(int status); 445 446 /** 447 * Returns the status by user ID of this message-boards message. 448 * 449 * @return the status by user ID of this message-boards message 450 */ 451 public long getStatusByUserId(); 452 453 /** 454 * Sets the status by user ID of this message-boards message. 455 * 456 * @param statusByUserId the status by user ID of this message-boards message 457 */ 458 public void setStatusByUserId(long statusByUserId); 459 460 /** 461 * Returns the status by user uuid of this message-boards message. 462 * 463 * @return the status by user uuid of this message-boards message 464 * @throws SystemException if a system exception occurred 465 */ 466 public String getStatusByUserUuid() throws SystemException; 467 468 /** 469 * Sets the status by user uuid of this message-boards message. 470 * 471 * @param statusByUserUuid the status by user uuid of this message-boards message 472 */ 473 public void setStatusByUserUuid(String statusByUserUuid); 474 475 /** 476 * Returns the status by user name of this message-boards message. 477 * 478 * @return the status by user name of this message-boards message 479 */ 480 @AutoEscape 481 public String getStatusByUserName(); 482 483 /** 484 * Sets the status by user name of this message-boards message. 485 * 486 * @param statusByUserName the status by user name of this message-boards message 487 */ 488 public void setStatusByUserName(String statusByUserName); 489 490 /** 491 * Returns the status date of this message-boards message. 492 * 493 * @return the status date of this message-boards message 494 */ 495 public Date getStatusDate(); 496 497 /** 498 * Sets the status date of this message-boards message. 499 * 500 * @param statusDate the status date of this message-boards message 501 */ 502 public void setStatusDate(Date statusDate); 503 504 /** 505 * @deprecated Renamed to {@link #isApproved()} 506 */ 507 public boolean getApproved(); 508 509 /** 510 * Returns <code>true</code> if this message-boards message is approved. 511 * 512 * @return <code>true</code> if this message-boards message is approved; <code>false</code> otherwise 513 */ 514 public boolean isApproved(); 515 516 /** 517 * Returns <code>true</code> if this message-boards message is denied. 518 * 519 * @return <code>true</code> if this message-boards message is denied; <code>false</code> otherwise 520 */ 521 public boolean isDenied(); 522 523 /** 524 * Returns <code>true</code> if this message-boards message is a draft. 525 * 526 * @return <code>true</code> if this message-boards message is a draft; <code>false</code> otherwise 527 */ 528 public boolean isDraft(); 529 530 /** 531 * Returns <code>true</code> if this message-boards message is expired. 532 * 533 * @return <code>true</code> if this message-boards message is expired; <code>false</code> otherwise 534 */ 535 public boolean isExpired(); 536 537 /** 538 * Returns <code>true</code> if this message-boards message is inactive. 539 * 540 * @return <code>true</code> if this message-boards message is inactive; <code>false</code> otherwise 541 */ 542 public boolean isInactive(); 543 544 /** 545 * Returns <code>true</code> if this message-boards message is incomplete. 546 * 547 * @return <code>true</code> if this message-boards message is incomplete; <code>false</code> otherwise 548 */ 549 public boolean isIncomplete(); 550 551 /** 552 * Returns <code>true</code> if this message-boards message is pending. 553 * 554 * @return <code>true</code> if this message-boards message is pending; <code>false</code> otherwise 555 */ 556 public boolean isPending(); 557 558 /** 559 * Returns <code>true</code> if this message-boards message is scheduled. 560 * 561 * @return <code>true</code> if this message-boards message is scheduled; <code>false</code> otherwise 562 */ 563 public boolean isScheduled(); 564 565 public boolean isNew(); 566 567 public void setNew(boolean n); 568 569 public boolean isCachedModel(); 570 571 public void setCachedModel(boolean cachedModel); 572 573 public boolean isEscapedModel(); 574 575 public Serializable getPrimaryKeyObj(); 576 577 public void setPrimaryKeyObj(Serializable primaryKeyObj); 578 579 public ExpandoBridge getExpandoBridge(); 580 581 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 582 583 public Object clone(); 584 585 public int compareTo(MBMessage mbMessage); 586 587 public int hashCode(); 588 589 public CacheModel<MBMessage> toCacheModel(); 590 591 public MBMessage toEscapedModel(); 592 593 public MBMessage toUnescapedModel(); 594 595 public String toString(); 596 597 public String toXmlString(); 598 }