com.liferay.portlet.messageboards.model
Interface MBThreadModel

All Superinterfaces:

BaseModel<MBThread>, java.lang.Cloneable, java.lang.Comparable<MBThread>, java.io.Serializable

All Known Subinterfaces:

MBThread

All Known Implementing Classes:

MBThreadWrapper

public interface MBThreadModel
extends BaseModel<MBThread>

The base model interface for the MBThread service. Represents a row in the "MBThread" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portlet.messageboards.model.impl.MBThreadModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portlet.messageboards.model.impl.MBThreadImpl.

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

Author:

Brian Wing Shun Chan

See Also:

MBThread, com.liferay.portlet.messageboards.model.impl.MBThreadImpl, com.liferay.portlet.messageboards.model.impl.MBThreadModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(MBThread mbThread)
long	getCategoryId() Gets the category id of this message boards thread.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this message boards thread.
long	getLastPostByUserId() Gets the last post by user id of this message boards thread.
java.lang.String	getLastPostByUserUuid() Gets the last post by user uuid of this message boards thread.
java.util.Date	getLastPostDate() Gets the last post date of this message boards thread.
int	getMessageCount() Gets the message count of this message boards thread.
long	getPrimaryKey() Gets the primary key of this message boards thread.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
double	getPriority() Gets the priority of this message boards thread.
long	getRootMessageId() Gets the root message id of this message boards thread.
int	getStatus() Gets the status of this message boards thread.
long	getStatusByUserId() Gets the status by user id of this message boards thread.
java.lang.String	getStatusByUserName() Gets the status by user name of this message boards thread.
java.lang.String	getStatusByUserUuid() Gets the status by user uuid of this message boards thread.
java.util.Date	getStatusDate() Gets the status date of this message boards thread.
long	getThreadId() Gets the thread id of this message boards thread.
int	getViewCount() Gets the view count of this message boards thread.
int	hashCode()
boolean	isApproved() Determines if this message boards thread is approved.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines if this message boards thread is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines if this message boards thread is expired.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPending() Determines if this message boards thread is pending.
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 thread.
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 thread.
void	setLastPostByUserId(long lastPostByUserId) Sets the last post by user id of this message boards thread.
void	setLastPostByUserUuid(java.lang.String lastPostByUserUuid) Sets the last post by user uuid of this message boards thread.
void	setLastPostDate(java.util.Date lastPostDate) Sets the last post date of this message boards thread.
void	setMessageCount(int messageCount) Sets the message count of this message boards thread.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this message boards thread
void	setPriority(double priority) Sets the priority of this message boards thread.
void	setRootMessageId(long rootMessageId) Sets the root message id of this message boards thread.
void	setStatus(int status) Sets the status of this message boards thread.
void	setStatusByUserId(long statusByUserId) Sets the status by user id of this message boards thread.
void	setStatusByUserName(java.lang.String statusByUserName) Sets the status by user name of this message boards thread.
void	setStatusByUserUuid(java.lang.String statusByUserUuid) Sets the status by user uuid of this message boards thread.
void	setStatusDate(java.util.Date statusDate) Sets the status date of this message boards thread.
void	setThreadId(long threadId) Sets the thread id of this message boards thread.
void	setViewCount(int viewCount) Sets the view count of this message boards thread.
MBThread	toEscapedModel() Gets a copy of this message boards thread as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
java.lang.String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this message boards thread.

Returns:

the primary key of this message boards thread

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this message boards thread

Parameters:

pk - the primary key of this message boards thread

getThreadId

long getThreadId()

Gets the thread id of this message boards thread.

Returns:

the thread id of this message boards thread

setThreadId

void setThreadId(long threadId)

Sets the thread id of this message boards thread.

Parameters:

threadId - the thread id of this message boards thread

getGroupId

long getGroupId()

Gets the group id of this message boards thread.

Returns:

the group id of this message boards thread

setGroupId

void setGroupId(long groupId)

Sets the group id of this message boards thread.

Parameters:

groupId - the group id of this message boards thread

getCategoryId

long getCategoryId()

Gets the category id of this message boards thread.

Returns:

the category id of this message boards thread

setCategoryId

void setCategoryId(long categoryId)

Sets the category id of this message boards thread.

Parameters:

categoryId - the category id of this message boards thread

getRootMessageId

long getRootMessageId()

Gets the root message id of this message boards thread.

Returns:

the root message id of this message boards thread

setRootMessageId

void setRootMessageId(long rootMessageId)

Sets the root message id of this message boards thread.

Parameters:

rootMessageId - the root message id of this message boards thread

getMessageCount

int getMessageCount()

Gets the message count of this message boards thread.

Returns:

the message count of this message boards thread

setMessageCount

void setMessageCount(int messageCount)

Sets the message count of this message boards thread.

Parameters:

messageCount - the message count of this message boards thread

getViewCount

int getViewCount()

Gets the view count of this message boards thread.

Returns:

the view count of this message boards thread

setViewCount

void setViewCount(int viewCount)

Sets the view count of this message boards thread.

Parameters:

viewCount - the view count of this message boards thread

getLastPostByUserId

long getLastPostByUserId()

Gets the last post by user id of this message boards thread.

Returns:

the last post by user id of this message boards thread

setLastPostByUserId

void setLastPostByUserId(long lastPostByUserId)

Sets the last post by user id of this message boards thread.

Parameters:

lastPostByUserId - the last post by user id of this message boards thread

getLastPostByUserUuid

java.lang.String getLastPostByUserUuid()
                                       throws SystemException

Gets the last post by user uuid of this message boards thread.

Returns:

the last post by user uuid of this message boards thread

Throws:

SystemException - if a system exception occurred

setLastPostByUserUuid

void setLastPostByUserUuid(java.lang.String lastPostByUserUuid)

Sets the last post by user uuid of this message boards thread.

Parameters:

lastPostByUserUuid - the last post by user uuid of this message boards thread

getLastPostDate

java.util.Date getLastPostDate()

Gets the last post date of this message boards thread.

Returns:

the last post date of this message boards thread

setLastPostDate

void setLastPostDate(java.util.Date lastPostDate)

Sets the last post date of this message boards thread.

Parameters:

lastPostDate - the last post date of this message boards thread

getPriority

double getPriority()

Gets the priority of this message boards thread.

Returns:

the priority of this message boards thread

setPriority

void setPriority(double priority)

Sets the priority of this message boards thread.

Parameters:

priority - the priority of this message boards thread

getStatus

int getStatus()

Gets the status of this message boards thread.

Returns:

the status of this message boards thread

setStatus

void setStatus(int status)

Sets the status of this message boards thread.

Parameters:

status - the status of this message boards thread

getStatusByUserId

long getStatusByUserId()

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

Returns:

the status by user id of this message boards thread

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user id of this message boards thread.

Parameters:

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

getStatusByUserUuid

java.lang.String getStatusByUserUuid()
                                     throws SystemException

Gets the status by user uuid of this message boards thread.

Returns:

the status by user uuid of this message boards thread

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(java.lang.String statusByUserUuid)

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

Parameters:

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

getStatusByUserName

@AutoEscape
java.lang.String getStatusByUserName()

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

Returns:

the status by user name of this message boards thread

setStatusByUserName

void setStatusByUserName(java.lang.String statusByUserName)

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

Parameters:

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

getStatusDate

java.util.Date getStatusDate()

Gets the status date of this message boards thread.

Returns:

the status date of this message boards thread

setStatusDate

void setStatusDate(java.util.Date statusDate)

Sets the status date of this message boards thread.

Parameters:

statusDate - the status date of this message boards thread

isApproved

boolean isApproved()

Determines if this message boards thread is approved.

Returns:

true if this message boards thread is approved; false otherwise

isDraft

boolean isDraft()

Determines if this message boards thread is a draft.

Returns:

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

isExpired

boolean isExpired()

Determines if this message boards thread is expired.

Returns:

true if this message boards thread is expired; false otherwise

isPending

boolean isPending()

Determines if this message boards thread is pending.

Returns:

true if this message boards thread is pending; false otherwise

toEscapedModel

MBThread toEscapedModel()

Gets a copy of this message boards thread 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<MBThread>

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<MBThread>

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<MBThread>

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<MBThread>

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<MBThread>

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<MBThread>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<MBThread>

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<MBThread>

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<MBThread>

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

java.lang.Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<MBThread>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(MBThread mbThread)

Specified by:

compareTo in interface java.lang.Comparable<MBThread>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<MBThread>

Returns:

the XML representation of this model instance