001 /** 002 * Copyright (c) 2000-2010 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.annotation.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 028 /** 029 * 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. 030 * 031 * <p> 032 * 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}. 033 * </p> 034 * 035 * <p> 036 * Never modify or reference this interface directly. All methods that expect a message-boards message model instance should use the {@link MBMessage} interface instead. 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 BaseModel<MBMessage> { 046 /** 047 * Gets the primary key of this message-boards message. 048 * 049 * @return the primary key of this message-boards message 050 */ 051 public long getPrimaryKey(); 052 053 /** 054 * Sets the primary key of this message-boards message 055 * 056 * @param pk the primary key of this message-boards message 057 */ 058 public void setPrimaryKey(long pk); 059 060 /** 061 * Gets the uuid of this message-boards message. 062 * 063 * @return the uuid of this message-boards message 064 */ 065 @AutoEscape 066 public String getUuid(); 067 068 /** 069 * Sets the uuid of this message-boards message. 070 * 071 * @param uuid the uuid of this message-boards message 072 */ 073 public void setUuid(String uuid); 074 075 /** 076 * Gets the message id of this message-boards message. 077 * 078 * @return the message id of this message-boards message 079 */ 080 public long getMessageId(); 081 082 /** 083 * Sets the message id of this message-boards message. 084 * 085 * @param messageId the message id of this message-boards message 086 */ 087 public void setMessageId(long messageId); 088 089 /** 090 * Gets the group id of this message-boards message. 091 * 092 * @return the group id of this message-boards message 093 */ 094 public long getGroupId(); 095 096 /** 097 * Sets the group id of this message-boards message. 098 * 099 * @param groupId the group id of this message-boards message 100 */ 101 public void setGroupId(long groupId); 102 103 /** 104 * Gets the company id of this message-boards message. 105 * 106 * @return the company id of this message-boards message 107 */ 108 public long getCompanyId(); 109 110 /** 111 * Sets the company id of this message-boards message. 112 * 113 * @param companyId the company id of this message-boards message 114 */ 115 public void setCompanyId(long companyId); 116 117 /** 118 * Gets the user id of this message-boards message. 119 * 120 * @return the user id of this message-boards message 121 */ 122 public long getUserId(); 123 124 /** 125 * Sets the user id of this message-boards message. 126 * 127 * @param userId the user id of this message-boards message 128 */ 129 public void setUserId(long userId); 130 131 /** 132 * Gets the user uuid of this message-boards message. 133 * 134 * @return the user uuid of this message-boards message 135 * @throws SystemException if a system exception occurred 136 */ 137 public String getUserUuid() throws SystemException; 138 139 /** 140 * Sets the user uuid of this message-boards message. 141 * 142 * @param userUuid the user uuid of this message-boards message 143 */ 144 public void setUserUuid(String userUuid); 145 146 /** 147 * Gets the user name of this message-boards message. 148 * 149 * @return the user name of this message-boards message 150 */ 151 @AutoEscape 152 public String getUserName(); 153 154 /** 155 * Sets the user name of this message-boards message. 156 * 157 * @param userName the user name of this message-boards message 158 */ 159 public void setUserName(String userName); 160 161 /** 162 * Gets the create date of this message-boards message. 163 * 164 * @return the create date of this message-boards message 165 */ 166 public Date getCreateDate(); 167 168 /** 169 * Sets the create date of this message-boards message. 170 * 171 * @param createDate the create date of this message-boards message 172 */ 173 public void setCreateDate(Date createDate); 174 175 /** 176 * Gets the modified date of this message-boards message. 177 * 178 * @return the modified date of this message-boards message 179 */ 180 public Date getModifiedDate(); 181 182 /** 183 * Sets the modified date of this message-boards message. 184 * 185 * @param modifiedDate the modified date of this message-boards message 186 */ 187 public void setModifiedDate(Date modifiedDate); 188 189 /** 190 * Gets the class name of the model instance this message-boards message is polymorphically associated with. 191 * 192 * @return the class name of the model instance this message-boards message is polymorphically associated with 193 */ 194 public String getClassName(); 195 196 /** 197 * Gets the class name id of this message-boards message. 198 * 199 * @return the class name id of this message-boards message 200 */ 201 public long getClassNameId(); 202 203 /** 204 * Sets the class name id of this message-boards message. 205 * 206 * @param classNameId the class name id of this message-boards message 207 */ 208 public void setClassNameId(long classNameId); 209 210 /** 211 * Gets the class p k of this message-boards message. 212 * 213 * @return the class p k of this message-boards message 214 */ 215 public long getClassPK(); 216 217 /** 218 * Sets the class p k of this message-boards message. 219 * 220 * @param classPK the class p k of this message-boards message 221 */ 222 public void setClassPK(long classPK); 223 224 /** 225 * Gets the category id of this message-boards message. 226 * 227 * @return the category id of this message-boards message 228 */ 229 public long getCategoryId(); 230 231 /** 232 * Sets the category id of this message-boards message. 233 * 234 * @param categoryId the category id of this message-boards message 235 */ 236 public void setCategoryId(long categoryId); 237 238 /** 239 * Gets the thread id of this message-boards message. 240 * 241 * @return the thread id of this message-boards message 242 */ 243 public long getThreadId(); 244 245 /** 246 * Sets the thread id of this message-boards message. 247 * 248 * @param threadId the thread id of this message-boards message 249 */ 250 public void setThreadId(long threadId); 251 252 /** 253 * Gets the root message id of this message-boards message. 254 * 255 * @return the root message id of this message-boards message 256 */ 257 public long getRootMessageId(); 258 259 /** 260 * Sets the root message id of this message-boards message. 261 * 262 * @param rootMessageId the root message id of this message-boards message 263 */ 264 public void setRootMessageId(long rootMessageId); 265 266 /** 267 * Gets the parent message id of this message-boards message. 268 * 269 * @return the parent message id of this message-boards message 270 */ 271 public long getParentMessageId(); 272 273 /** 274 * Sets the parent message id of this message-boards message. 275 * 276 * @param parentMessageId the parent message id of this message-boards message 277 */ 278 public void setParentMessageId(long parentMessageId); 279 280 /** 281 * Gets the subject of this message-boards message. 282 * 283 * @return the subject of this message-boards message 284 */ 285 @AutoEscape 286 public String getSubject(); 287 288 /** 289 * Sets the subject of this message-boards message. 290 * 291 * @param subject the subject of this message-boards message 292 */ 293 public void setSubject(String subject); 294 295 /** 296 * Gets the body of this message-boards message. 297 * 298 * @return the body of this message-boards message 299 */ 300 @AutoEscape 301 public String getBody(); 302 303 /** 304 * Sets the body of this message-boards message. 305 * 306 * @param body the body of this message-boards message 307 */ 308 public void setBody(String body); 309 310 /** 311 * Gets the attachments of this message-boards message. 312 * 313 * @return the attachments of this message-boards message 314 */ 315 public boolean getAttachments(); 316 317 /** 318 * Determines whether this message-boards message is attachments. 319 * 320 * @return whether this message-boards message is attachments 321 */ 322 public boolean isAttachments(); 323 324 /** 325 * Sets whether this {$entity.humanName} is attachments. 326 * 327 * @param attachments the attachments of this message-boards message 328 */ 329 public void setAttachments(boolean attachments); 330 331 /** 332 * Gets the anonymous of this message-boards message. 333 * 334 * @return the anonymous of this message-boards message 335 */ 336 public boolean getAnonymous(); 337 338 /** 339 * Determines whether this message-boards message is anonymous. 340 * 341 * @return whether this message-boards message is anonymous 342 */ 343 public boolean isAnonymous(); 344 345 /** 346 * Sets whether this {$entity.humanName} is anonymous. 347 * 348 * @param anonymous the anonymous of this message-boards message 349 */ 350 public void setAnonymous(boolean anonymous); 351 352 /** 353 * Gets the priority of this message-boards message. 354 * 355 * @return the priority of this message-boards message 356 */ 357 public double getPriority(); 358 359 /** 360 * Sets the priority of this message-boards message. 361 * 362 * @param priority the priority of this message-boards message 363 */ 364 public void setPriority(double priority); 365 366 /** 367 * Gets the allow pingbacks of this message-boards message. 368 * 369 * @return the allow pingbacks of this message-boards message 370 */ 371 public boolean getAllowPingbacks(); 372 373 /** 374 * Determines whether this message-boards message is allow pingbacks. 375 * 376 * @return whether this message-boards message is allow pingbacks 377 */ 378 public boolean isAllowPingbacks(); 379 380 /** 381 * Sets whether this {$entity.humanName} is allow pingbacks. 382 * 383 * @param allowPingbacks the allow pingbacks of this message-boards message 384 */ 385 public void setAllowPingbacks(boolean allowPingbacks); 386 387 /** 388 * Gets the status of this message-boards message. 389 * 390 * @return the status of this message-boards message 391 */ 392 public int getStatus(); 393 394 /** 395 * Sets the status of this message-boards message. 396 * 397 * @param status the status of this message-boards message 398 */ 399 public void setStatus(int status); 400 401 /** 402 * Gets the status by user id of this message-boards message. 403 * 404 * @return the status by user id of this message-boards message 405 */ 406 public long getStatusByUserId(); 407 408 /** 409 * Sets the status by user id of this message-boards message. 410 * 411 * @param statusByUserId the status by user id of this message-boards message 412 */ 413 public void setStatusByUserId(long statusByUserId); 414 415 /** 416 * Gets the status by user uuid of this message-boards message. 417 * 418 * @return the status by user uuid of this message-boards message 419 * @throws SystemException if a system exception occurred 420 */ 421 public String getStatusByUserUuid() throws SystemException; 422 423 /** 424 * Sets the status by user uuid of this message-boards message. 425 * 426 * @param statusByUserUuid the status by user uuid of this message-boards message 427 */ 428 public void setStatusByUserUuid(String statusByUserUuid); 429 430 /** 431 * Gets the status by user name of this message-boards message. 432 * 433 * @return the status by user name of this message-boards message 434 */ 435 @AutoEscape 436 public String getStatusByUserName(); 437 438 /** 439 * Sets the status by user name of this message-boards message. 440 * 441 * @param statusByUserName the status by user name of this message-boards message 442 */ 443 public void setStatusByUserName(String statusByUserName); 444 445 /** 446 * Gets the status date of this message-boards message. 447 * 448 * @return the status date of this message-boards message 449 */ 450 public Date getStatusDate(); 451 452 /** 453 * Sets the status date of this message-boards message. 454 * 455 * @param statusDate the status date of this message-boards message 456 */ 457 public void setStatusDate(Date statusDate); 458 459 /** 460 * Determines whether this message-boards message is approved. 461 * 462 * @return true if this message-boards message is approved; false otherwise 463 */ 464 public boolean isApproved(); 465 466 /** 467 * Determines whether this message-boards message is a draft. 468 * 469 * @return true if this message-boards message is a draft; false otherwise 470 */ 471 public boolean isDraft(); 472 473 /** 474 * Determines whether this message-boards message is expired. 475 * 476 * @return true if this message-boards message is expired; false otherwise 477 */ 478 public boolean isExpired(); 479 480 /** 481 * Determines whether this message-boards message is pending. 482 * 483 * @return true if this message-boards message is pending; false otherwise 484 */ 485 public boolean isPending(); 486 487 /** 488 * Gets a copy of this message-boards message as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 489 * 490 * @return the escaped model instance 491 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 492 */ 493 public MBMessage toEscapedModel(); 494 495 public boolean isNew(); 496 497 public void setNew(boolean n); 498 499 public boolean isCachedModel(); 500 501 public void setCachedModel(boolean cachedModel); 502 503 public boolean isEscapedModel(); 504 505 public void setEscapedModel(boolean escapedModel); 506 507 public Serializable getPrimaryKeyObj(); 508 509 public ExpandoBridge getExpandoBridge(); 510 511 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 512 513 public Object clone(); 514 515 public int compareTo(MBMessage mbMessage); 516 517 public int hashCode(); 518 519 public String toString(); 520 521 public String toXmlString(); 522 }