com.liferay.portlet.messageboards.model
Interface MBMessageModel

All Superinterfaces:

BaseModel<MBMessage>, Cloneable, Comparable<MBMessage>, Serializable

All Known Subinterfaces:

MBMessage

All Known Implementing Classes:

MBMessageImpl, MBMessageModelImpl, MBMessageWrapper

public interface MBMessageModel
extends BaseModel<MBMessage>

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.

Never modify or reference this interface directly. All methods that expect a message-boards message model instance should use the MBMessage interface instead.

See Also:

MBMessage, MBMessageImpl, MBMessageModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(MBMessage mbMessage)
boolean	getAllowPingbacks() Gets the allow pingbacks of this message-boards message.
boolean	getAnonymous() Gets the anonymous of this message-boards message.
boolean	getAttachments() Gets the attachments of this message-boards message.
String	getBody() Gets the body of this message-boards message.
long	getCategoryId() Gets the category id of this message-boards message.
String	getClassName() Gets the class name of the model instance this message-boards message is polymorphically associated with.
long	getClassNameId() Gets the class name id of this message-boards message.
long	getClassPK() Gets the class p k of this message-boards message.
long	getCompanyId() Gets the company id of this message-boards message.
Date	getCreateDate() Gets the create date of this message-boards message.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this message-boards message.
long	getMessageId() Gets the message id of this message-boards message.
Date	getModifiedDate() Gets the modified date of this message-boards message.
long	getParentMessageId() Gets the parent message id of this message-boards message.
long	getPrimaryKey() Gets the primary key of this message-boards message.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
double	getPriority() Gets the priority of this message-boards message.
long	getRootMessageId() Gets the root message id of this message-boards message.
int	getStatus() Gets the status of this message-boards message.
long	getStatusByUserId() Gets the status by user id of this message-boards message.
String	getStatusByUserName() Gets the status by user name of this message-boards message.
String	getStatusByUserUuid() Gets the status by user uuid of this message-boards message.
Date	getStatusDate() Gets the status date of this message-boards message.
String	getSubject() Gets the subject of this message-boards message.
long	getThreadId() Gets the thread id of this message-boards message.
long	getUserId() Gets the user id of this message-boards message.
String	getUserName() Gets the user name of this message-boards message.
String	getUserUuid() Gets the user uuid of this message-boards message.
String	getUuid() Gets the uuid of this message-boards message.
int	hashCode()
boolean	isAllowPingbacks() Determines whether this message-boards message is allow pingbacks.
boolean	isAnonymous() Determines whether this message-boards message is anonymous.
boolean	isApproved() Determines whether this message-boards message is approved.
boolean	isAttachments() Determines whether this message-boards message is attachments.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines whether this message-boards message is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines whether this message-boards message is expired.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPending() Determines whether this message-boards message is pending.
void	setAllowPingbacks(boolean allowPingbacks) Sets whether this {$entity.humanName} is allow pingbacks.
void	setAnonymous(boolean anonymous) Sets whether this {$entity.humanName} is anonymous.
void	setAttachments(boolean attachments) Sets whether this {$entity.humanName} 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	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	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
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 pk) Sets the primary key of this message-boards message
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.
MBMessage	toEscapedModel() Gets a copy of this message-boards message as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this message-boards message.

Returns:

the primary key of this message-boards message

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this message-boards message

Parameters:

pk - the primary key of this message-boards message

getUuid

@AutoEscape
String getUuid()

Gets 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()

Gets 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()

Gets the group id of this message-boards message.

Returns:

the group id of this message-boards message

setGroupId

void setGroupId(long groupId)

Sets the group id of this message-boards message.

Parameters:

groupId - the group id of this message-boards message

getCompanyId

long getCompanyId()

Gets the company id of this message-boards message.

Returns:

the company id of this message-boards message

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this message-boards message.

Parameters:

companyId - the company id of this message-boards message

getUserId

long getUserId()

Gets the user id of this message-boards message.

Returns:

the user id of this message-boards message

setUserId

void setUserId(long userId)

Sets the user id of this message-boards message.

Parameters:

userId - the user id of this message-boards message

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this message-boards message.

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.

Parameters:

userUuid - the user uuid of this message-boards message

getUserName

@AutoEscape
String getUserName()

Gets the user name of this message-boards message.

Returns:

the user name of this message-boards message

setUserName

void setUserName(String userName)

Sets the user name of this message-boards message.

Parameters:

userName - the user name of this message-boards message

getCreateDate

Date getCreateDate()

Gets the create date of this message-boards message.

Returns:

the create date of this message-boards message

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this message-boards message.

Parameters:

createDate - the create date of this message-boards message

getModifiedDate

Date getModifiedDate()

Gets the modified date of this message-boards message.

Returns:

the modified date of this message-boards message

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this message-boards message.

Parameters:

modifiedDate - the modified date of this message-boards message

getClassName

String getClassName()

Gets the class name of the model instance this message-boards message is polymorphically associated with.

Returns:

the class name of the model instance this message-boards message is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this message-boards message.

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.

Parameters:

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

getClassPK

long getClassPK()

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

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.

Parameters:

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

getCategoryId

long getCategoryId()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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

getAttachments

boolean getAttachments()

Gets the attachments of this message-boards message.

Returns:

the attachments of this message-boards message

isAttachments

boolean isAttachments()

Determines whether this message-boards message is attachments.

Returns:

whether this message-boards message is attachments

setAttachments

void setAttachments(boolean attachments)

Sets whether this {$entity.humanName} is attachments.

Parameters:

attachments - the attachments of this message-boards message

getAnonymous

boolean getAnonymous()

Gets the anonymous of this message-boards message.

Returns:

the anonymous of this message-boards message

isAnonymous

boolean isAnonymous()

Determines whether this message-boards message is anonymous.

Returns:

whether this message-boards message is anonymous

setAnonymous

void setAnonymous(boolean anonymous)

Sets whether this {$entity.humanName} is anonymous.

Parameters:

anonymous - the anonymous of this message-boards message

getPriority

double getPriority()

Gets 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()

Gets the allow pingbacks of this message-boards message.

Returns:

the allow pingbacks of this message-boards message

isAllowPingbacks

boolean isAllowPingbacks()

Determines whether this message-boards message is allow pingbacks.

Returns:

whether this message-boards message is allow pingbacks

setAllowPingbacks

void setAllowPingbacks(boolean allowPingbacks)

Sets whether this {$entity.humanName} is allow pingbacks.

Parameters:

allowPingbacks - the allow pingbacks of this message-boards message

getStatus

int getStatus()

Gets the status of this message-boards message.

Returns:

the status of this message-boards message

setStatus

void setStatus(int status)

Sets the status of this message-boards message.

Parameters:

status - the status of this message-boards message

getStatusByUserId

long getStatusByUserId()

Gets the status by user id of this message-boards message.

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.

Parameters:

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

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Gets 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()

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

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.

Parameters:

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

getStatusDate

Date getStatusDate()

Gets the status date of this message-boards message.

Returns:

the status date of this message-boards message

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this message-boards message.

Parameters:

statusDate - the status date of this message-boards message

isApproved

boolean isApproved()

Determines whether this message-boards message is approved.

Returns:

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

isDraft

boolean isDraft()

Determines whether this message-boards message is a draft.

Returns:

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

isExpired

boolean isExpired()

Determines whether this message-boards message is expired.

Returns:

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

isPending

boolean isPending()

Determines whether this message-boards message is pending.

Returns:

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

toEscapedModel

MBMessage toEscapedModel()

Gets a copy of this message-boards message as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

boolean isNew()

Description copied from interface: BaseModel

Determines 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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<MBMessage>

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<MBMessage>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<MBMessage>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<MBMessage>

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 to retrieve the expando bridge attributes from

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

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<MBMessage>

Returns:

the XML representation of this model instance