com.liferay.portlet.messageboards.model
Interface MBMessageModel

All Superinterfaces:

AttachedModel, AuditedModel, BaseModel<MBMessage>, ClassedModel, Cloneable, Comparable<MBMessage>, GroupedModel, Serializable, WorkflowedModel

All Known Subinterfaces:

MBMessage

All Known Implementing Classes:

MBMessageWrapper

public interface MBMessageModel
extends AttachedModel, BaseModel<MBMessage>, GroupedModel, WorkflowedModel

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.

This interface and its corresponding implementation MBMessageModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in MBMessageImpl.

See Also:

MBMessage, MBMessageImpl, MBMessageModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(MBMessage mbMessage)
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. Renamed to isApproved()
boolean	getAttachments() Returns the attachments of this message-boards message.
String	getBody() Returns the body of this message-boards message.
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.
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.
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.
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.
long	getThreadId() Returns the thread ID of 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.
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	isAttachments() Returns true if this message-boards message is attachments.
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	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	isInactive() Returns true if this message-boards message is inactive.
boolean	isIncomplete() Returns true if this message-boards message is incomplete.
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	isScheduled() Returns true if this message-boards message is scheduled.
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	setAttachments(boolean attachments) Sets whether this message-boards message is attachments.
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(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	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 interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this message-boards message.

Returns:

the primary key of this message-boards message

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this message-boards message.

Parameters:

primaryKey - the primary key of this message-boards message

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this message-boards message.

Returns:

the uuid of this message-boards message

setUuid

void setUuid(String uuid)

Sets the uuid of this message-boards message.

Parameters:

uuid - the uuid of this message-boards message

getMessageId

long getMessageId()

Returns the message ID of this message-boards message.

Returns:

the message ID of this message-boards message

setMessageId

void setMessageId(long messageId)

Sets the message ID of this message-boards message.

Parameters:

messageId - the message ID of this message-boards message

getGroupId

long getGroupId()

Returns the group ID of this message-boards message.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this message-boards message

setGroupId

void setGroupId(long groupId)

Sets the group ID of this message-boards message.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this message-boards message

getCompanyId

long getCompanyId()

Returns the company ID of this message-boards message.

Specified by:

getCompanyId in interface AuditedModel

Returns:

the company ID of this message-boards message

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this message-boards message.

Specified by:

setCompanyId in interface AuditedModel

Parameters:

companyId - the company ID of this message-boards message

getUserId

long getUserId()

Returns the user ID of this message-boards message.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this message-boards message

setUserId

void setUserId(long userId)

Sets the user ID of this message-boards message.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this message-boards message

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this message-boards message.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this message-boards message

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this message-boards message.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this message-boards message

getUserName

@AutoEscape
String getUserName()

Returns the user name of this message-boards message.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this message-boards message

setUserName

void setUserName(String userName)

Sets the user name of this message-boards message.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this message-boards message

getCreateDate

Date getCreateDate()

Returns the create date of this message-boards message.

Specified by:

getCreateDate in interface AuditedModel

Returns:

the create date of this message-boards message

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this message-boards message.

Specified by:

setCreateDate in interface AuditedModel

Parameters:

createDate - the create date of this message-boards message

getModifiedDate

Date getModifiedDate()

Returns the modified date of this message-boards message.

Specified by:

getModifiedDate in interface AuditedModel

Returns:

the modified date of this message-boards message

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this message-boards message.

Specified by:

setModifiedDate in interface AuditedModel

Parameters:

modifiedDate - the modified date of this message-boards message

getClassName

String getClassName()

Returns the fully qualified class name of this message-boards message.

Specified by:

getClassName in interface AttachedModel

Returns:

the fully qualified class name of this message-boards message

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this message-boards message.

Specified by:

getClassNameId in interface AttachedModel

Returns:

the class name ID of this message-boards message

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this message-boards message.

Specified by:

setClassNameId in interface AttachedModel

Parameters:

classNameId - the class name ID of this message-boards message

getClassPK

long getClassPK()

Returns the class p k of this message-boards message.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class p k of this message-boards message

setClassPK

void setClassPK(long classPK)

Sets the class p k of this message-boards message.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class p k of this message-boards message

getCategoryId

long getCategoryId()

Returns the category ID of this message-boards message.

Returns:

the category ID of this message-boards message

setCategoryId

void setCategoryId(long categoryId)

Sets the category ID of this message-boards message.

Parameters:

categoryId - the category ID of this message-boards message

getThreadId

long getThreadId()

Returns the thread ID of this message-boards message.

Returns:

the thread ID of this message-boards message

setThreadId

void setThreadId(long threadId)

Sets the thread ID of this message-boards message.

Parameters:

threadId - the thread ID of this message-boards message

getRootMessageId

long getRootMessageId()

Returns the root message ID of this message-boards message.

Returns:

the root message ID of this message-boards message

setRootMessageId

void setRootMessageId(long rootMessageId)

Sets the root message ID of this message-boards message.

Parameters:

rootMessageId - the root message ID of this message-boards message

getParentMessageId

long getParentMessageId()

Returns the parent message ID of this message-boards message.

Returns:

the parent message ID of this message-boards message

setParentMessageId

void setParentMessageId(long parentMessageId)

Sets the parent message ID of this message-boards message.

Parameters:

parentMessageId - the parent message ID of this message-boards message

getSubject

@AutoEscape
String getSubject()

Returns the subject of this message-boards message.

Returns:

the subject of this message-boards message

setSubject

void setSubject(String subject)

Sets the subject of this message-boards message.

Parameters:

subject - the subject of this message-boards message

getBody

@AutoEscape
String getBody()

Returns the body of this message-boards message.

Returns:

the body of this message-boards message

setBody

void setBody(String body)

Sets the body of this message-boards message.

Parameters:

body - the body of this message-boards message

getFormat

@AutoEscape
String getFormat()

Returns the format of this message-boards message.

Returns:

the format of this message-boards message

setFormat

void setFormat(String format)

Sets the format of this message-boards message.

Parameters:

format - the format of this message-boards message

getAttachments

boolean getAttachments()

Returns the attachments of this message-boards message.

Returns:

the attachments of this message-boards message

isAttachments

boolean isAttachments()

Returns true if this message-boards message is attachments.

Returns:

true if this message-boards message is attachments; false otherwise

setAttachments

void setAttachments(boolean attachments)

Sets whether this message-boards message is attachments.

Parameters:

attachments - the attachments of this message-boards message

getAnonymous

boolean getAnonymous()

Returns the anonymous of this message-boards message.

Returns:

the anonymous of this message-boards message

isAnonymous

boolean isAnonymous()

Returns true if this message-boards message is anonymous.

Returns:

true if this message-boards message is anonymous; false otherwise

setAnonymous

void setAnonymous(boolean anonymous)

Sets whether this message-boards message is anonymous.

Parameters:

anonymous - the anonymous of this message-boards message

getPriority

double getPriority()

Returns the priority of this message-boards message.

Returns:

the priority of this message-boards message

setPriority

void setPriority(double priority)

Sets the priority of this message-boards message.

Parameters:

priority - the priority of this message-boards message

getAllowPingbacks

boolean getAllowPingbacks()

Returns the allow pingbacks of this message-boards message.

Returns:

the allow pingbacks of this message-boards message

isAllowPingbacks

boolean isAllowPingbacks()

Returns true if this message-boards message is allow pingbacks.

Returns:

true if this message-boards message is allow pingbacks; false otherwise

setAllowPingbacks

void setAllowPingbacks(boolean allowPingbacks)

Sets whether this message-boards message is allow pingbacks.

Parameters:

allowPingbacks - the allow pingbacks of this message-boards message

getAnswer

boolean getAnswer()

Returns the answer of this message-boards message.

Returns:

the answer of this message-boards message

isAnswer

boolean isAnswer()

Returns true if this message-boards message is answer.

Returns:

true if this message-boards message is answer; false otherwise

setAnswer

void setAnswer(boolean answer)

Sets whether this message-boards message is answer.

Parameters:

answer - the answer of this message-boards message

getStatus

int getStatus()

Returns the status of this message-boards message.

Specified by:

getStatus in interface WorkflowedModel

Returns:

the status of this message-boards message

setStatus

void setStatus(int status)

Sets the status of this message-boards message.

Specified by:

setStatus in interface WorkflowedModel

Parameters:

status - the status of this message-boards message

getStatusByUserId

long getStatusByUserId()

Returns the status by user ID of this message-boards message.

Specified by:

getStatusByUserId in interface WorkflowedModel

Returns:

the status by user ID of this message-boards message

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user ID of this message-boards message.

Specified by:

setStatusByUserId in interface WorkflowedModel

Parameters:

statusByUserId - the status by user ID of this message-boards message

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Returns the status by user uuid of this message-boards message.

Returns:

the status by user uuid of this message-boards message

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this message-boards message.

Parameters:

statusByUserUuid - the status by user uuid of this message-boards message

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Returns the status by user name of this message-boards message.

Specified by:

getStatusByUserName in interface WorkflowedModel

Returns:

the status by user name of this message-boards message

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this message-boards message.

Specified by:

setStatusByUserName in interface WorkflowedModel

Parameters:

statusByUserName - the status by user name of this message-boards message

getStatusDate

Date getStatusDate()

Returns the status date of this message-boards message.

Specified by:

getStatusDate in interface WorkflowedModel

Returns:

the status date of this message-boards message

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this message-boards message.

Specified by:

setStatusDate in interface WorkflowedModel

Parameters:

statusDate - the status date of this message-boards message

getApproved

boolean getApproved()

Deprecated. Renamed to isApproved()

isApproved

boolean isApproved()

Returns true if this message-boards message is approved.

Specified by:

isApproved in interface WorkflowedModel

Returns:

true if this message-boards message is approved; false otherwise

isDenied

boolean isDenied()

Returns true if this message-boards message is denied.

Returns:

true if this message-boards message is denied; false otherwise

isDraft

boolean isDraft()

Returns true if this message-boards message is a draft.

Specified by:

isDraft in interface WorkflowedModel

Returns:

true if this message-boards message is a draft; false otherwise

isExpired

boolean isExpired()

Returns true if this message-boards message is expired.

Specified by:

isExpired in interface WorkflowedModel

Returns:

true if this message-boards message is expired; false otherwise

isInactive

boolean isInactive()

Returns true if this message-boards message is inactive.

Returns:

true if this message-boards message is inactive; false otherwise

isIncomplete

boolean isIncomplete()

Returns true if this message-boards message is incomplete.

Returns:

true if this message-boards message is incomplete; false otherwise

isPending

boolean isPending()

Returns true if this message-boards message is pending.

Specified by:

isPending in interface WorkflowedModel

Returns:

true if this message-boards message is pending; false otherwise

isScheduled

boolean isScheduled()

Returns true if this message-boards message is scheduled.

Returns:

true if this message-boards message is scheduled; false otherwise

isNew

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>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

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>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

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>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<MBMessage>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

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

Returns:

the primary key of this model instance

setPrimaryKeyObj

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

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

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>

Parameters:

serviceContext - the service context

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<MBMessage>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(MBMessage mbMessage)

Specified by:

compareTo in interface Comparable<MBMessage>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

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>

Returns:

the cache model object

toEscapedModel

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>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

MBMessage toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<MBMessage>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<MBMessage>

Returns:

the XML representation of this model instance