Liferay 6.2-ce-ga5

com.liferay.portlet.messageboards.model
Class MBMessageWrapper

java.lang.Object
  extended by com.liferay.portlet.messageboards.model.MBMessageWrapper
All Implemented Interfaces:
AttachedModel, AuditedModel, BaseModel<MBMessage>, ClassedModel, GroupedModel, ModelWrapper<MBMessage>, PersistedModel, StagedGroupedModel, StagedModel, TrashedModel, TypedModel, WorkflowedModel, MBMessage, MBMessageModel, Serializable, Cloneable, Comparable<MBMessage>

@ProviderType
public class MBMessageWrapper
extends Object
implements MBMessage, ModelWrapper<MBMessage>

This class is a wrapper for MBMessage.

See Also:
MBMessage, Serialized Form

Constructor Summary
MBMessageWrapper(MBMessage mbMessage)
           
 
Method Summary
 Folder addAttachmentsFolder()
           
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(MBMessage mbMessage)
           
 boolean equals(Object obj)
           
 boolean getAllowPingbacks()
          Returns the allow pingbacks of this message-boards message.
 boolean getAnonymous()
          Returns the anonymous of this message-boards message.
 boolean getAnswer()
          Returns the answer of this message-boards message.
 boolean getApproved()
          Deprecated. As of 6.1.0, replaced by isApproved()
 String[] getAssetTagNames()
           
 List<FileEntry> getAttachmentsFileEntries()
           
 List<FileEntry> getAttachmentsFileEntries(int start, int end)
           
 int getAttachmentsFileEntriesCount()
           
 long getAttachmentsFolderId()
           
 String getBody()
          Returns the body of this message-boards message.
 String getBody(boolean translate)
           
 MBCategory getCategory()
           
 long getCategoryId()
          Returns the category ID of this message-boards message.
 String getClassName()
          Returns the fully qualified class name of this message-boards message.
 long getClassNameId()
          Returns the class name ID of this message-boards message.
 long getClassPK()
          Returns the class p k of this message-boards message.
 long getCompanyId()
          Returns the company ID of this message-boards message.
 Date getCreateDate()
          Returns the create date of this message-boards message.
 List<FileEntry> getDeletedAttachmentsFileEntries()
           
 List<FileEntry> getDeletedAttachmentsFileEntries(int start, int end)
           
 int getDeletedAttachmentsFileEntriesCount()
           
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getFormat()
          Returns the format of this message-boards message.
 long getGroupId()
          Returns the group ID of this message-boards message.
 long getMessageId()
          Returns the message ID of this message-boards message.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 Date getModifiedDate()
          Returns the modified date of this message-boards message.
 long getParentMessageId()
          Returns the parent message ID of this message-boards message.
 long getPrimaryKey()
          Returns the primary key of this message-boards message.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 double getPriority()
          Returns the priority of this message-boards message.
 long getRootMessageId()
          Returns the root message ID of this message-boards message.
 StagedModelType getStagedModelType()
           
 int getStatus()
          Returns the status of this message-boards message.
 long getStatusByUserId()
          Returns the status by user ID of this message-boards message.
 String getStatusByUserName()
          Returns the status by user name of this message-boards message.
 String getStatusByUserUuid()
          Returns the status by user uuid of this message-boards message.
 Date getStatusDate()
          Returns the status date of this message-boards message.
 String getSubject()
          Returns the subject of this message-boards message.
 MBThread getThread()
           
 long getThreadAttachmentsFolderId()
           
 long getThreadId()
          Returns the thread ID of this message-boards message.
 TrashEntry getTrashEntry()
          Returns the trash entry created when this message-boards message was moved to the Recycle Bin.
 long getTrashEntryClassPK()
          Returns the class primary key of the trash entry for this message-boards message.
 TrashHandler getTrashHandler()
          Returns the trash handler for this message-boards message.
 long getUserId()
          Returns the user ID of this message-boards message.
 String getUserName()
          Returns the user name of this message-boards message.
 String getUserUuid()
          Returns the user uuid of this message-boards message.
 String getUuid()
          Returns the uuid of this message-boards message.
 String getWorkflowClassName()
           
 MBMessage getWrappedMBMessage()
          Deprecated. As of 6.1.0, replaced by getWrappedModel()
 MBMessage getWrappedModel()
           
 int hashCode()
           
 boolean isAllowPingbacks()
          Returns true if this message-boards message is allow pingbacks.
 boolean isAnonymous()
          Returns true if this message-boards message is anonymous.
 boolean isAnswer()
          Returns true if this message-boards message is answer.
 boolean isApproved()
          Returns true if this message-boards message is approved.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDenied()
          Returns true if this message-boards message is denied.
 boolean isDiscussion()
           
 boolean isDraft()
          Returns true if this message-boards message is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Returns true if this message-boards message is expired.
 boolean isFormatBBCode()
           
 boolean isInactive()
          Returns true if this message-boards message is inactive.
 boolean isIncomplete()
          Returns true if this message-boards message is incomplete.
 boolean isInTrash()
          Returns true if this message-boards message is in the Recycle Bin.
 boolean isInTrashContainer()
          Returns true if the parent of this message-boards message is in the Recycle Bin.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPending()
          Returns true if this message-boards message is pending.
 boolean isReply()
           
 boolean isRoot()
           
 boolean isScheduled()
          Returns true if this message-boards message is scheduled.
 void persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void resetOriginalValues()
          Reset all original fields to current values.
 void setAllowPingbacks(boolean allowPingbacks)
          Sets whether this message-boards message is allow pingbacks.
 void setAnonymous(boolean anonymous)
          Sets whether this message-boards message is anonymous.
 void setAnswer(boolean answer)
          Sets whether this message-boards message is answer.
 void setAttachmentsFolderId(long attachmentsFolderId)
           
 void setBody(String body)
          Sets the body of this message-boards message.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCategoryId(long categoryId)
          Sets the category ID of this message-boards message.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this message-boards message.
 void setClassPK(long classPK)
          Sets the class p k of this message-boards message.
 void setCompanyId(long companyId)
          Sets the company ID of this message-boards message.
 void setCreateDate(Date createDate)
          Sets the create date of this message-boards message.
 void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFormat(String format)
          Sets the format of this message-boards message.
 void setGroupId(long groupId)
          Sets the group ID of this message-boards message.
 void setMessageId(long messageId)
          Sets the message ID of this message-boards message.
 void setModelAttributes(Map<String,Object> attributes)
           
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this message-boards message.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentMessageId(long parentMessageId)
          Sets the parent message ID of this message-boards message.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this message-boards message.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setPriority(double priority)
          Sets the priority of this message-boards message.
 void setRootMessageId(long rootMessageId)
          Sets the root message ID of this message-boards message.
 void setStatus(int status)
          Sets the status of this message-boards message.
 void setStatusByUserId(long statusByUserId)
          Sets the status by user ID of this message-boards message.
 void setStatusByUserName(String statusByUserName)
          Sets the status by user name of this message-boards message.
 void setStatusByUserUuid(String statusByUserUuid)
          Sets the status by user uuid of this message-boards message.
 void setStatusDate(Date statusDate)
          Sets the status date of this message-boards message.
 void setSubject(String subject)
          Sets the subject of this message-boards message.
 void setThreadId(long threadId)
          Sets the thread ID of this message-boards message.
 void setUserId(long userId)
          Sets the user ID of this message-boards message.
 void setUserName(String userName)
          Sets the user name of this message-boards message.
 void setUserUuid(String userUuid)
          Sets the user uuid of this message-boards message.
 void setUuid(String uuid)
          Sets the uuid of this message-boards message.
 CacheModel<MBMessage> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 MBMessage toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 MBMessage toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MBMessageWrapper

public MBMessageWrapper(MBMessage mbMessage)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<MBMessage>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<MBMessage>

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this message-boards message.

Specified by:
getPrimaryKey in interface MBMessageModel
Returns:
the primary key of this message-boards message

setPrimaryKey

public void setPrimaryKey(long primaryKey)
Sets the primary key of this message-boards message.

Specified by:
setPrimaryKey in interface MBMessageModel
Parameters:
primaryKey - the primary key of this message-boards message

getUuid

public String getUuid()
Returns the uuid of this message-boards message.

Specified by:
getUuid in interface StagedModel
Specified by:
getUuid in interface MBMessageModel
Returns:
the uuid of this message-boards message

setUuid

public void setUuid(String uuid)
Sets the uuid of this message-boards message.

Specified by:
setUuid in interface StagedModel
Specified by:
setUuid in interface MBMessageModel
Parameters:
uuid - the uuid of this message-boards message

getMessageId

public long getMessageId()
Returns the message ID of this message-boards message.

Specified by:
getMessageId in interface MBMessageModel
Returns:
the message ID of this message-boards message

setMessageId

public void setMessageId(long messageId)
Sets the message ID of this message-boards message.

Specified by:
setMessageId in interface MBMessageModel
Parameters:
messageId - the message ID of this message-boards message

getGroupId

public long getGroupId()
Returns the group ID of this message-boards message.

Specified by:
getGroupId in interface GroupedModel
Specified by:
getGroupId in interface MBMessageModel
Returns:
the group ID of this message-boards message

setGroupId

public void setGroupId(long groupId)
Sets the group ID of this message-boards message.

Specified by:
setGroupId in interface GroupedModel
Specified by:
setGroupId in interface MBMessageModel
Parameters:
groupId - the group ID of this message-boards message

getCompanyId

public long getCompanyId()
Returns the company ID of this message-boards message.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface StagedModel
Specified by:
getCompanyId in interface MBMessageModel
Returns:
the company ID of this message-boards message

setCompanyId

public void setCompanyId(long companyId)
Sets the company ID of this message-boards message.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface StagedModel
Specified by:
setCompanyId in interface MBMessageModel
Parameters:
companyId - the company ID of this message-boards message

getUserId

public long getUserId()
Returns the user ID of this message-boards message.

Specified by:
getUserId in interface AuditedModel
Specified by:
getUserId in interface MBMessageModel
Returns:
the user ID of this message-boards message

setUserId

public void setUserId(long userId)
Sets the user ID of this message-boards message.

Specified by:
setUserId in interface AuditedModel
Specified by:
setUserId in interface MBMessageModel
Parameters:
userId - the user ID of this message-boards message

getUserUuid

public String getUserUuid()
                   throws SystemException
Returns the user uuid of this message-boards message.

Specified by:
getUserUuid in interface AuditedModel
Specified by:
getUserUuid in interface MBMessageModel
Returns:
the user uuid of this message-boards message
Throws:
SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)
Sets the user uuid of this message-boards message.

Specified by:
setUserUuid in interface AuditedModel
Specified by:
setUserUuid in interface MBMessageModel
Parameters:
userUuid - the user uuid of this message-boards message

getUserName

public String getUserName()
Returns the user name of this message-boards message.

Specified by:
getUserName in interface AuditedModel
Specified by:
getUserName in interface MBMessageModel
Returns:
the user name of this message-boards message

setUserName

public void setUserName(String userName)
Sets the user name of this message-boards message.

Specified by:
setUserName in interface AuditedModel
Specified by:
setUserName in interface MBMessageModel
Parameters:
userName - the user name of this message-boards message

getCreateDate

public Date getCreateDate()
Returns the create date of this message-boards message.

Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface StagedModel
Specified by:
getCreateDate in interface MBMessageModel
Returns:
the create date of this message-boards message

setCreateDate

public void setCreateDate(Date createDate)
Sets the create date of this message-boards message.

Specified by:
setCreateDate in interface AuditedModel
Specified by:
setCreateDate in interface StagedModel
Specified by:
setCreateDate in interface MBMessageModel
Parameters:
createDate - the create date of this message-boards message

getModifiedDate

public Date getModifiedDate()
Returns the modified date of this message-boards message.

Specified by:
getModifiedDate in interface AuditedModel
Specified by:
getModifiedDate in interface StagedModel
Specified by:
getModifiedDate in interface MBMessageModel
Returns:
the modified date of this message-boards message

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Sets the modified date of this message-boards message.

Specified by:
setModifiedDate in interface AuditedModel
Specified by:
setModifiedDate in interface StagedModel
Specified by:
setModifiedDate in interface MBMessageModel
Parameters:
modifiedDate - the modified date of this message-boards message

getClassName

public String getClassName()
Returns the fully qualified class name of this message-boards message.

Specified by:
getClassName in interface TypedModel
Specified by:
getClassName in interface MBMessageModel
Returns:
the fully qualified class name of this message-boards message

setClassName

public void setClassName(String className)
Specified by:
setClassName in interface MBMessageModel

getClassNameId

public long getClassNameId()
Returns the class name ID of this message-boards message.

Specified by:
getClassNameId in interface TypedModel
Specified by:
getClassNameId in interface MBMessageModel
Returns:
the class name ID of this message-boards message

setClassNameId

public void setClassNameId(long classNameId)
Sets the class name ID of this message-boards message.

Specified by:
setClassNameId in interface TypedModel
Specified by:
setClassNameId in interface MBMessageModel
Parameters:
classNameId - the class name ID of this message-boards message

getClassPK

public long getClassPK()
Returns the class p k of this message-boards message.

Specified by:
getClassPK in interface AttachedModel
Specified by:
getClassPK in interface MBMessageModel
Returns:
the class p k of this message-boards message

setClassPK

public void setClassPK(long classPK)
Sets the class p k of this message-boards message.

Specified by:
setClassPK in interface AttachedModel
Specified by:
setClassPK in interface MBMessageModel
Parameters:
classPK - the class p k of this message-boards message

getCategoryId

public long getCategoryId()
Returns the category ID of this message-boards message.

Specified by:
getCategoryId in interface MBMessageModel
Returns:
the category ID of this message-boards message

setCategoryId

public void setCategoryId(long categoryId)
Sets the category ID of this message-boards message.

Specified by:
setCategoryId in interface MBMessageModel
Parameters:
categoryId - the category ID of this message-boards message

getThreadId

public long getThreadId()
Returns the thread ID of this message-boards message.

Specified by:
getThreadId in interface MBMessageModel
Returns:
the thread ID of this message-boards message

setThreadId

public void setThreadId(long threadId)
Sets the thread ID of this message-boards message.

Specified by:
setThreadId in interface MBMessageModel
Parameters:
threadId - the thread ID of this message-boards message

getRootMessageId

public long getRootMessageId()
Returns the root message ID of this message-boards message.

Specified by:
getRootMessageId in interface MBMessageModel
Returns:
the root message ID of this message-boards message

setRootMessageId

public void setRootMessageId(long rootMessageId)
Sets the root message ID of this message-boards message.

Specified by:
setRootMessageId in interface MBMessageModel
Parameters:
rootMessageId - the root message ID of this message-boards message

getParentMessageId

public long getParentMessageId()
Returns the parent message ID of this message-boards message.

Specified by:
getParentMessageId in interface MBMessageModel
Returns:
the parent message ID of this message-boards message

setParentMessageId

public void setParentMessageId(long parentMessageId)
Sets the parent message ID of this message-boards message.

Specified by:
setParentMessageId in interface MBMessageModel
Parameters:
parentMessageId - the parent message ID of this message-boards message

getSubject

public String getSubject()
Returns the subject of this message-boards message.

Specified by:
getSubject in interface MBMessageModel
Returns:
the subject of this message-boards message

setSubject

public void setSubject(String subject)
Sets the subject of this message-boards message.

Specified by:
setSubject in interface MBMessageModel
Parameters:
subject - the subject of this message-boards message

getBody

public String getBody()
Returns the body of this message-boards message.

Specified by:
getBody in interface MBMessageModel
Returns:
the body of this message-boards message

setBody

public void setBody(String body)
Sets the body of this message-boards message.

Specified by:
setBody in interface MBMessageModel
Parameters:
body - the body of this message-boards message

getFormat

public String getFormat()
Returns the format of this message-boards message.

Specified by:
getFormat in interface MBMessageModel
Returns:
the format of this message-boards message

setFormat

public void setFormat(String format)
Sets the format of this message-boards message.

Specified by:
setFormat in interface MBMessageModel
Parameters:
format - the format of this message-boards message

getAnonymous

public boolean getAnonymous()
Returns the anonymous of this message-boards message.

Specified by:
getAnonymous in interface MBMessageModel
Returns:
the anonymous of this message-boards message

isAnonymous

public boolean isAnonymous()
Returns true if this message-boards message is anonymous.

Specified by:
isAnonymous in interface MBMessageModel
Returns:
true if this message-boards message is anonymous; false otherwise

setAnonymous

public void setAnonymous(boolean anonymous)
Sets whether this message-boards message is anonymous.

Specified by:
setAnonymous in interface MBMessageModel
Parameters:
anonymous - the anonymous of this message-boards message

getPriority

public double getPriority()
Returns the priority of this message-boards message.

Specified by:
getPriority in interface MBMessageModel
Returns:
the priority of this message-boards message

setPriority

public void setPriority(double priority)
Sets the priority of this message-boards message.

Specified by:
setPriority in interface MBMessageModel
Parameters:
priority - the priority of this message-boards message

getAllowPingbacks

public boolean getAllowPingbacks()
Returns the allow pingbacks of this message-boards message.

Specified by:
getAllowPingbacks in interface MBMessageModel
Returns:
the allow pingbacks of this message-boards message

isAllowPingbacks

public boolean isAllowPingbacks()
Returns true if this message-boards message is allow pingbacks.

Specified by:
isAllowPingbacks in interface MBMessageModel
Returns:
true if this message-boards message is allow pingbacks; false otherwise

setAllowPingbacks

public void setAllowPingbacks(boolean allowPingbacks)
Sets whether this message-boards message is allow pingbacks.

Specified by:
setAllowPingbacks in interface MBMessageModel
Parameters:
allowPingbacks - the allow pingbacks of this message-boards message

getAnswer

public boolean getAnswer()
Returns the answer of this message-boards message.

Specified by:
getAnswer in interface MBMessageModel
Returns:
the answer of this message-boards message

isAnswer

public boolean isAnswer()
Returns true if this message-boards message is answer.

Specified by:
isAnswer in interface MBMessageModel
Returns:
true if this message-boards message is answer; false otherwise

setAnswer

public void setAnswer(boolean answer)
Sets whether this message-boards message is answer.

Specified by:
setAnswer in interface MBMessageModel
Parameters:
answer - the answer of this message-boards message

getStatus

public int getStatus()
Returns the status of this message-boards message.

Specified by:
getStatus in interface TrashedModel
Specified by:
getStatus in interface WorkflowedModel
Specified by:
getStatus in interface MBMessageModel
Returns:
the status of this message-boards message

setStatus

public void setStatus(int status)
Sets the status of this message-boards message.

Specified by:
setStatus in interface WorkflowedModel
Specified by:
setStatus in interface MBMessageModel
Parameters:
status - the status of this message-boards message

getStatusByUserId

public long getStatusByUserId()
Returns the status by user ID of this message-boards message.

Specified by:
getStatusByUserId in interface WorkflowedModel
Specified by:
getStatusByUserId in interface MBMessageModel
Returns:
the status by user ID of this message-boards message

setStatusByUserId

public void setStatusByUserId(long statusByUserId)
Sets the status by user ID of this message-boards message.

Specified by:
setStatusByUserId in interface WorkflowedModel
Specified by:
setStatusByUserId in interface MBMessageModel
Parameters:
statusByUserId - the status by user ID of this message-boards message

getStatusByUserUuid

public String getStatusByUserUuid()
                           throws SystemException
Returns the status by user uuid of this message-boards message.

Specified by:
getStatusByUserUuid in interface WorkflowedModel
Specified by:
getStatusByUserUuid in interface MBMessageModel
Returns:
the status by user uuid of this message-boards message
Throws:
SystemException - if a system exception occurred

setStatusByUserUuid

public void setStatusByUserUuid(String statusByUserUuid)
Sets the status by user uuid of this message-boards message.

Specified by:
setStatusByUserUuid in interface WorkflowedModel
Specified by:
setStatusByUserUuid in interface MBMessageModel
Parameters:
statusByUserUuid - the status by user uuid of this message-boards message

getStatusByUserName

public String getStatusByUserName()
Returns the status by user name of this message-boards message.

Specified by:
getStatusByUserName in interface WorkflowedModel
Specified by:
getStatusByUserName in interface MBMessageModel
Returns:
the status by user name of this message-boards message

setStatusByUserName

public void setStatusByUserName(String statusByUserName)
Sets the status by user name of this message-boards message.

Specified by:
setStatusByUserName in interface WorkflowedModel
Specified by:
setStatusByUserName in interface MBMessageModel
Parameters:
statusByUserName - the status by user name of this message-boards message

getStatusDate

public Date getStatusDate()
Returns the status date of this message-boards message.

Specified by:
getStatusDate in interface WorkflowedModel
Specified by:
getStatusDate in interface MBMessageModel
Returns:
the status date of this message-boards message

setStatusDate

public void setStatusDate(Date statusDate)
Sets the status date of this message-boards message.

Specified by:
setStatusDate in interface WorkflowedModel
Specified by:
setStatusDate in interface MBMessageModel
Parameters:
statusDate - the status date of this message-boards message

getTrashEntry

public TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException
Returns the trash entry created when this message-boards message was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this message-boards message.

Specified by:
getTrashEntry in interface TrashedModel
Specified by:
getTrashEntry in interface MBMessageModel
Returns:
the trash entry created when this message-boards message was moved to the Recycle Bin
Throws:
SystemException - if a system exception occurred
PortalException

getTrashEntryClassPK

public long getTrashEntryClassPK()
Returns the class primary key of the trash entry for this message-boards message.

Specified by:
getTrashEntryClassPK in interface TrashedModel
Specified by:
getTrashEntryClassPK in interface MBMessageModel
Returns:
the class primary key of the trash entry for this message-boards message

getTrashHandler

public TrashHandler getTrashHandler()
Returns the trash handler for this message-boards message.

Specified by:
getTrashHandler in interface TrashedModel
Specified by:
getTrashHandler in interface MBMessageModel
Returns:
the trash handler for this message-boards message

isInTrash

public boolean isInTrash()
Returns true if this message-boards message is in the Recycle Bin.

Specified by:
isInTrash in interface TrashedModel
Specified by:
isInTrash in interface MBMessageModel
Returns:
true if this message-boards message is in the Recycle Bin; false otherwise

isInTrashContainer

public boolean isInTrashContainer()
Returns true if the parent of this message-boards message is in the Recycle Bin.

Specified by:
isInTrashContainer in interface TrashedModel
Specified by:
isInTrashContainer in interface MBMessageModel
Returns:
true if the parent of this message-boards message is in the Recycle Bin; false otherwise
Throws:
SystemException - if a system exception occurred

getApproved

public boolean getApproved()
Deprecated. As of 6.1.0, replaced by isApproved()

Specified by:
getApproved in interface WorkflowedModel
Specified by:
getApproved in interface MBMessageModel

isApproved

public boolean isApproved()
Returns true if this message-boards message is approved.

Specified by:
isApproved in interface WorkflowedModel
Specified by:
isApproved in interface MBMessageModel
Returns:
true if this message-boards message is approved; false otherwise

isDenied

public boolean isDenied()
Returns true if this message-boards message is denied.

Specified by:
isDenied in interface WorkflowedModel
Specified by:
isDenied in interface MBMessageModel
Returns:
true if this message-boards message is denied; false otherwise

isDraft

public boolean isDraft()
Returns true if this message-boards message is a draft.

Specified by:
isDraft in interface WorkflowedModel
Specified by:
isDraft in interface MBMessageModel
Returns:
true if this message-boards message is a draft; false otherwise

isExpired

public boolean isExpired()
Returns true if this message-boards message is expired.

Specified by:
isExpired in interface WorkflowedModel
Specified by:
isExpired in interface MBMessageModel
Returns:
true if this message-boards message is expired; false otherwise

isInactive

public boolean isInactive()
Returns true if this message-boards message is inactive.

Specified by:
isInactive in interface WorkflowedModel
Specified by:
isInactive in interface MBMessageModel
Returns:
true if this message-boards message is inactive; false otherwise

isIncomplete

public boolean isIncomplete()
Returns true if this message-boards message is incomplete.

Specified by:
isIncomplete in interface WorkflowedModel
Specified by:
isIncomplete in interface MBMessageModel
Returns:
true if this message-boards message is incomplete; false otherwise

isPending

public boolean isPending()
Returns true if this message-boards message is pending.

Specified by:
isPending in interface WorkflowedModel
Specified by:
isPending in interface MBMessageModel
Returns:
true if this message-boards message is pending; false otherwise

isScheduled

public boolean isScheduled()
Returns true if this message-boards message is scheduled.

Specified by:
isScheduled in interface WorkflowedModel
Specified by:
isScheduled in interface MBMessageModel
Returns:
true if this message-boards message is scheduled; false otherwise

isNew

public boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<MBMessage>
Specified by:
isNew in interface MBMessageModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<MBMessage>
Specified by:
setNew in interface MBMessageModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<MBMessage>
Specified by:
isCachedModel in interface MBMessageModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<MBMessage>
Specified by:
setCachedModel in interface MBMessageModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<MBMessage>
Specified by:
isEscapedModel in interface MBMessageModel
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<MBMessage>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Specified by:
getPrimaryKeyObj in interface MBMessageModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<MBMessage>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Specified by:
setPrimaryKeyObj in interface MBMessageModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<MBMessage>
Specified by:
getExpandoBridge in interface ClassedModel
Specified by:
getExpandoBridge in interface MBMessageModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<MBMessage>
Specified by:
setExpandoBridgeAttributes in interface MBMessageModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<MBMessage>
Specified by:
setExpandoBridgeAttributes in interface MBMessageModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<MBMessage>
Specified by:
setExpandoBridgeAttributes in interface MBMessageModel
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<MBMessage>
Specified by:
clone in interface StagedModel
Specified by:
clone in interface MBMessageModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(MBMessage mbMessage)
Specified by:
compareTo in interface MBMessageModel
Specified by:
compareTo in interface Comparable<MBMessage>

hashCode

public int hashCode()
Specified by:
hashCode in interface MBMessageModel
Overrides:
hashCode in class Object

toCacheModel

public CacheModel<MBMessage> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<MBMessage>
Specified by:
toCacheModel in interface MBMessageModel
Returns:
the cache model object

toEscapedModel

public MBMessage toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<MBMessage>
Specified by:
toEscapedModel in interface MBMessageModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

public MBMessage toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<MBMessage>
Specified by:
toUnescapedModel in interface MBMessageModel

toString

public String toString()
Specified by:
toString in interface MBMessageModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<MBMessage>
Specified by:
toXmlString in interface MBMessageModel
Returns:
the XML representation of this model instance

persist

public void persist()
             throws SystemException
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel
Throws:
SystemException - if a system exception occurred

addAttachmentsFolder

public Folder addAttachmentsFolder()
                            throws PortalException,
                                   SystemException
Specified by:
addAttachmentsFolder in interface MBMessage
Throws:
PortalException
SystemException

getAssetTagNames

public String[] getAssetTagNames()
                          throws SystemException
Specified by:
getAssetTagNames in interface MBMessage
Throws:
SystemException

getAttachmentsFileEntries

public List<FileEntry> getAttachmentsFileEntries()
                                          throws PortalException,
                                                 SystemException
Specified by:
getAttachmentsFileEntries in interface MBMessage
Throws:
PortalException
SystemException

getAttachmentsFileEntries

public List<FileEntry> getAttachmentsFileEntries(int start,
                                                 int end)
                                          throws PortalException,
                                                 SystemException
Specified by:
getAttachmentsFileEntries in interface MBMessage
Throws:
PortalException
SystemException

getAttachmentsFileEntriesCount

public int getAttachmentsFileEntriesCount()
                                   throws PortalException,
                                          SystemException
Specified by:
getAttachmentsFileEntriesCount in interface MBMessage
Throws:
PortalException
SystemException

getAttachmentsFolderId

public long getAttachmentsFolderId()
                            throws PortalException,
                                   SystemException
Specified by:
getAttachmentsFolderId in interface MBMessage
Throws:
PortalException
SystemException

getBody

public String getBody(boolean translate)
Specified by:
getBody in interface MBMessage

getCategory

public MBCategory getCategory()
                       throws PortalException,
                              SystemException
Specified by:
getCategory in interface MBMessage
Throws:
PortalException
SystemException

getDeletedAttachmentsFileEntries

public List<FileEntry> getDeletedAttachmentsFileEntries()
                                                 throws PortalException,
                                                        SystemException
Specified by:
getDeletedAttachmentsFileEntries in interface MBMessage
Throws:
PortalException
SystemException

getDeletedAttachmentsFileEntries

public List<FileEntry> getDeletedAttachmentsFileEntries(int start,
                                                        int end)
                                                 throws PortalException,
                                                        SystemException
Specified by:
getDeletedAttachmentsFileEntries in interface MBMessage
Throws:
PortalException
SystemException

getDeletedAttachmentsFileEntriesCount

public int getDeletedAttachmentsFileEntriesCount()
                                          throws PortalException,
                                                 SystemException
Specified by:
getDeletedAttachmentsFileEntriesCount in interface MBMessage
Throws:
PortalException
SystemException

getThread

public MBThread getThread()
                   throws PortalException,
                          SystemException
Specified by:
getThread in interface MBMessage
Throws:
PortalException
SystemException

getThreadAttachmentsFolderId

public long getThreadAttachmentsFolderId()
                                  throws PortalException,
                                         SystemException
Specified by:
getThreadAttachmentsFolderId in interface MBMessage
Throws:
PortalException
SystemException

getWorkflowClassName

public String getWorkflowClassName()
Specified by:
getWorkflowClassName in interface MBMessage

isDiscussion

public boolean isDiscussion()
Specified by:
isDiscussion in interface MBMessage

isFormatBBCode

public boolean isFormatBBCode()
Specified by:
isFormatBBCode in interface MBMessage

isReply

public boolean isReply()
Specified by:
isReply in interface MBMessage

isRoot

public boolean isRoot()
Specified by:
isRoot in interface MBMessage

setAttachmentsFolderId

public void setAttachmentsFolderId(long attachmentsFolderId)
Specified by:
setAttachmentsFolderId in interface MBMessage

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getStagedModelType

public StagedModelType getStagedModelType()
Specified by:
getStagedModelType in interface StagedModel

getWrappedMBMessage

public MBMessage getWrappedMBMessage()
Deprecated. As of 6.1.0, replaced by getWrappedModel()


getWrappedModel

public MBMessage getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<MBMessage>

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<MBMessage>

Liferay 6.2-ce-ga5