Liferay 6.0-ee-sp2

com.liferay.portlet.messageboards.model
Interface MBThreadModel

All Superinterfaces:
BaseModel<MBThread>, ClassedModel, Cloneable, Comparable<MBThread>, Serializable, WorkflowedModel
All Known Subinterfaces:
MBThread
All Known Implementing Classes:
MBThreadWrapper

public interface MBThreadModel
extends BaseModel<MBThread>, WorkflowedModel

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 MBThreadModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in MBThreadImpl.

See Also:
MBThread, MBThreadImpl, MBThreadModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(MBThread mbThread)
           
 boolean getApproved()
          Deprecated. isApproved()
 long getCategoryId()
          Gets the category ID of this message boards thread.
 long getCompanyId()
          Gets the company ID of this message boards thread.
 ExpandoBridge getExpandoBridge()
          Returns 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.
 String getLastPostByUserUuid()
          Gets the last post by user uuid of this message boards thread.
 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.
 Serializable getPrimaryKeyObj()
          Returns 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.
 long getRootMessageUserId()
          Gets the root message user ID of this message boards thread.
 String getRootMessageUserUuid()
          Gets the root message user uuid 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.
 String getStatusByUserName()
          Gets the status by user name of this message boards thread.
 String getStatusByUserUuid()
          Gets the status by user uuid of this message boards thread.
 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()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDraft()
          Determines if this message boards thread is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Determines if this message boards thread is expired.
 boolean isNew()
          Returns true 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 setCompanyId(long companyId)
          Sets the company 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(String lastPostByUserUuid)
          Sets the last post by user uuid of this message boards thread.
 void setLastPostDate(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 primaryKey)
          Sets the primary key of this message boards thread
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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 setRootMessageUserId(long rootMessageUserId)
          Sets the root message user ID of this message boards thread.
 void setRootMessageUserUuid(String rootMessageUserUuid)
          Sets the root message user uuid 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(String statusByUserName)
          Sets the status by user name of this message boards thread.
 void setStatusByUserUuid(String statusByUserUuid)
          Sets the status by user uuid of this message boards thread.
 void setStatusDate(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.
 CacheModel<MBThread> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 MBThread toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

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 primaryKey)
Sets the primary key of this message boards thread

Parameters:
primaryKey - 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

getCompanyId

long getCompanyId()
Gets the company ID of this message boards thread.

Returns:
the company ID of this message boards thread

setCompanyId

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

Parameters:
companyId - the company 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

getRootMessageUserId

long getRootMessageUserId()
Gets the root message user ID of this message boards thread.

Returns:
the root message user ID of this message boards thread

setRootMessageUserId

void setRootMessageUserId(long rootMessageUserId)
Sets the root message user ID of this message boards thread.

Parameters:
rootMessageUserId - the root message user ID of this message boards thread

getRootMessageUserUuid

String getRootMessageUserUuid()
                              throws SystemException
Gets the root message user uuid of this message boards thread.

Returns:
the root message user uuid of this message boards thread
Throws:
SystemException - if a system exception occurred

setRootMessageUserUuid

void setRootMessageUserUuid(String rootMessageUserUuid)
Sets the root message user uuid of this message boards thread.

Parameters:
rootMessageUserUuid - the root message user uuid 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

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

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(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.

Specified by:
getStatus in interface WorkflowedModel
Returns:
the status of this message boards thread

setStatus

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

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

getStatusByUserId

long getStatusByUserId()
Gets the status by user ID of this message boards thread.

Specified by:
getStatusByUserId in interface WorkflowedModel
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.

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

getStatusByUserUuid

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(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
String getStatusByUserName()
Gets the status by user name of this message boards thread.

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

setStatusByUserName

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

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

getStatusDate

Date getStatusDate()
Gets the status date of this message boards thread.

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

setStatusDate

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

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

getApproved

boolean getApproved()
Deprecated. isApproved()


isApproved

boolean isApproved()
Determines if this message boards thread is approved.

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

isDraft

boolean isDraft()
Determines if this message boards thread is a draft.

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

isExpired

boolean isExpired()
Determines if this message boards thread is expired.

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

isPending

boolean isPending()
Determines if this message boards thread is pending.

Specified by:
isPending in interface WorkflowedModel
Returns:
true if this message boards thread is pending; 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<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
Returns true 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
Returns true 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

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

Specified by:
getPrimaryKeyObj in interface BaseModel<MBThread>
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<MBThread>
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<MBThread>
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<MBThread>
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<MBThread>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(MBThread mbThread)
Specified by:
compareTo in interface Comparable<MBThread>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

MBThread 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<MBThread>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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<MBThread>
Returns:
the XML representation of this model instance

Liferay 6.0-ee-sp2