001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets 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 * Gets the class name of the model instance this message-boards message is polymorphically associated with. 198 * 199 * @return the class name of the model instance this message-boards message is polymorphically associated with 200 */ 201 public String getClassName(); 202 203 /** 204 * Gets the class name ID of this message-boards message. 205 * 206 * @return the class name ID of this message-boards message 207 */ 208 public long getClassNameId(); 209 210 /** 211 * Sets the class name ID of this message-boards message. 212 * 213 * @param classNameId the class name ID of this message-boards message 214 */ 215 public void setClassNameId(long classNameId); 216 217 /** 218 * Gets the class p k of this message-boards message. 219 * 220 * @return the class p k of this message-boards message 221 */ 222 public long getClassPK(); 223 224 /** 225 * Sets the class p k of this message-boards message. 226 * 227 * @param classPK the class p k of this message-boards message 228 */ 229 public void setClassPK(long classPK); 230 231 /** 232 * Gets the category ID of this message-boards message. 233 * 234 * @return the category ID of this message-boards message 235 */ 236 public long getCategoryId(); 237 238 /** 239 * Sets the category ID of this message-boards message. 240 * 241 * @param categoryId the category ID of this message-boards message 242 */ 243 public void setCategoryId(long categoryId); 244 245 /** 246 * Gets the thread ID of this message-boards message. 247 * 248 * @return the thread ID of this message-boards message 249 */ 250 public long getThreadId(); 251 252 /** 253 * Sets the thread ID of this message-boards message. 254 * 255 * @param threadId the thread ID of this message-boards message 256 */ 257 public void setThreadId(long threadId); 258 259 /** 260 * Gets the root message ID of this message-boards message. 261 * 262 * @return the root message ID of this message-boards message 263 */ 264 public long getRootMessageId(); 265 266 /** 267 * Sets the root message ID of this message-boards message. 268 * 269 * @param rootMessageId the root message ID of this message-boards message 270 */ 271 public void setRootMessageId(long rootMessageId); 272 273 /** 274 * Gets the parent message ID of this message-boards message. 275 * 276 * @return the parent message ID of this message-boards message 277 */ 278 public long getParentMessageId(); 279 280 /** 281 * Sets the parent message ID of this message-boards message. 282 * 283 * @param parentMessageId the parent message ID of this message-boards message 284 */ 285 public void setParentMessageId(long parentMessageId); 286 287 /** 288 * Gets the subject of this message-boards message. 289 * 290 * @return the subject of this message-boards message 291 */ 292 @AutoEscape 293 public String getSubject(); 294 295 /** 296 * Sets the subject of this message-boards message. 297 * 298 * @param subject the subject of this message-boards message 299 */ 300 public void setSubject(String subject); 301 302 /** 303 * Gets the body of this message-boards message. 304 * 305 * @return the body of this message-boards message 306 */ 307 @AutoEscape 308 public String getBody(); 309 310 /** 311 * Sets the body of this message-boards message. 312 * 313 * @param body the body of this message-boards message 314 */ 315 public void setBody(String body); 316 317 /** 318 * Gets the attachments of this message-boards message. 319 * 320 * @return the attachments of this message-boards message 321 */ 322 public boolean getAttachments(); 323 324 /** 325 * Determines if this message-boards message is attachments. 326 * 327 * @return <code>true</code> if this message-boards message is attachments; <code>false</code> otherwise 328 */ 329 public boolean isAttachments(); 330 331 /** 332 * Sets whether this message-boards message is attachments. 333 * 334 * @param attachments the attachments of this message-boards message 335 */ 336 public void setAttachments(boolean attachments); 337 338 /** 339 * Gets the anonymous of this message-boards message. 340 * 341 * @return the anonymous of this message-boards message 342 */ 343 public boolean getAnonymous(); 344 345 /** 346 * Determines if this message-boards message is anonymous. 347 * 348 * @return <code>true</code> if this message-boards message is anonymous; <code>false</code> otherwise 349 */ 350 public boolean isAnonymous(); 351 352 /** 353 * Sets whether this message-boards message is anonymous. 354 * 355 * @param anonymous the anonymous of this message-boards message 356 */ 357 public void setAnonymous(boolean anonymous); 358 359 /** 360 * Gets the priority of this message-boards message. 361 * 362 * @return the priority of this message-boards message 363 */ 364 public double getPriority(); 365 366 /** 367 * Sets the priority of this message-boards message. 368 * 369 * @param priority the priority of this message-boards message 370 */ 371 public void setPriority(double priority); 372 373 /** 374 * Gets the allow pingbacks of this message-boards message. 375 * 376 * @return the allow pingbacks of this message-boards message 377 */ 378 public boolean getAllowPingbacks(); 379 380 /** 381 * Determines if this message-boards message is allow pingbacks. 382 * 383 * @return <code>true</code> if this message-boards message is allow pingbacks; <code>false</code> otherwise 384 */ 385 public boolean isAllowPingbacks(); 386 387 /** 388 * Sets whether this message-boards message is allow pingbacks. 389 * 390 * @param allowPingbacks the allow pingbacks of this message-boards message 391 */ 392 public void setAllowPingbacks(boolean allowPingbacks); 393 394 /** 395 * Gets the status of this message-boards message. 396 * 397 * @return the status of this message-boards message 398 */ 399 public int getStatus(); 400 401 /** 402 * Sets the status of this message-boards message. 403 * 404 * @param status the status of this message-boards message 405 */ 406 public void setStatus(int status); 407 408 /** 409 * Gets the status by user ID of this message-boards message. 410 * 411 * @return the status by user ID of this message-boards message 412 */ 413 public long getStatusByUserId(); 414 415 /** 416 * Sets the status by user ID of this message-boards message. 417 * 418 * @param statusByUserId the status by user ID of this message-boards message 419 */ 420 public void setStatusByUserId(long statusByUserId); 421 422 /** 423 * Gets the status by user uuid of this message-boards message. 424 * 425 * @return the status by user uuid of this message-boards message 426 * @throws SystemException if a system exception occurred 427 */ 428 public String getStatusByUserUuid() throws SystemException; 429 430 /** 431 * Sets the status by user uuid of this message-boards message. 432 * 433 * @param statusByUserUuid the status by user uuid of this message-boards message 434 */ 435 public void setStatusByUserUuid(String statusByUserUuid); 436 437 /** 438 * Gets the status by user name of this message-boards message. 439 * 440 * @return the status by user name of this message-boards message 441 */ 442 @AutoEscape 443 public String getStatusByUserName(); 444 445 /** 446 * Sets the status by user name of this message-boards message. 447 * 448 * @param statusByUserName the status by user name of this message-boards message 449 */ 450 public void setStatusByUserName(String statusByUserName); 451 452 /** 453 * Gets the status date of this message-boards message. 454 * 455 * @return the status date of this message-boards message 456 */ 457 public Date getStatusDate(); 458 459 /** 460 * Sets the status date of this message-boards message. 461 * 462 * @param statusDate the status date of this message-boards message 463 */ 464 public void setStatusDate(Date statusDate); 465 466 /** 467 * @deprecated {@link #isApproved} 468 */ 469 public boolean getApproved(); 470 471 /** 472 * Determines if this message-boards message is approved. 473 * 474 * @return <code>true</code> if this message-boards message is approved; <code>false</code> otherwise 475 */ 476 public boolean isApproved(); 477 478 /** 479 * Determines if this message-boards message is a draft. 480 * 481 * @return <code>true</code> if this message-boards message is a draft; <code>false</code> otherwise 482 */ 483 public boolean isDraft(); 484 485 /** 486 * Determines if this message-boards message is expired. 487 * 488 * @return <code>true</code> if this message-boards message is expired; <code>false</code> otherwise 489 */ 490 public boolean isExpired(); 491 492 /** 493 * Determines if this message-boards message is pending. 494 * 495 * @return <code>true</code> if this message-boards message is pending; <code>false</code> otherwise 496 */ 497 public boolean isPending(); 498 499 public boolean isNew(); 500 501 public void setNew(boolean n); 502 503 public boolean isCachedModel(); 504 505 public void setCachedModel(boolean cachedModel); 506 507 public boolean isEscapedModel(); 508 509 public void setEscapedModel(boolean escapedModel); 510 511 public Serializable getPrimaryKeyObj(); 512 513 public void setPrimaryKeyObj(Serializable primaryKeyObj); 514 515 public ExpandoBridge getExpandoBridge(); 516 517 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 518 519 public Object clone(); 520 521 public int compareTo(MBMessage mbMessage); 522 523 public int hashCode(); 524 525 public CacheModel<MBMessage> toCacheModel(); 526 527 public MBMessage toEscapedModel(); 528 529 public String toString(); 530 531 public String toXmlString(); 532 }