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