Liferay 6.1.2-ce-ga3

com.liferay.portlet.messageboards.model
Interface MBCategoryModel

All Superinterfaces:
AuditedModel, BaseModel<MBCategory>, ClassedModel, Cloneable, Comparable<MBCategory>, GroupedModel, Serializable
All Known Subinterfaces:
MBCategory
All Known Implementing Classes:
MBCategoryWrapper

public interface MBCategoryModel
extends BaseModel<MBCategory>, GroupedModel

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

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

See Also:
MBCategory, MBCategoryImpl, MBCategoryModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(MBCategory mbCategory)
           
 long getCategoryId()
          Returns the category ID of this message boards category.
 long getCompanyId()
          Returns the company ID of this message boards category.
 Date getCreateDate()
          Returns the create date of this message boards category.
 String getDescription()
          Returns the description of this message boards category.
 String getDisplayStyle()
          Returns the display style of this message boards category.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this message boards category.
 Date getLastPostDate()
          Returns the last post date of this message boards category.
 int getMessageCount()
          Returns the message count of this message boards category.
 Date getModifiedDate()
          Returns the modified date of this message boards category.
 String getName()
          Returns the name of this message boards category.
 long getParentCategoryId()
          Returns the parent category ID of this message boards category.
 long getPrimaryKey()
          Returns the primary key of this message boards category.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getThreadCount()
          Returns the thread count of this message boards category.
 long getUserId()
          Returns the user ID of this message boards category.
 String getUserName()
          Returns the user name of this message boards category.
 String getUserUuid()
          Returns the user uuid of this message boards category.
 String getUuid()
          Returns the uuid of this message boards category.
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 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 category.
 void setCompanyId(long companyId)
          Sets the company ID of this message boards category.
 void setCreateDate(Date createDate)
          Sets the create date of this message boards category.
 void setDescription(String description)
          Sets the description of this message boards category.
 void setDisplayStyle(String displayStyle)
          Sets the display style of this message boards category.
 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 category.
 void setLastPostDate(Date lastPostDate)
          Sets the last post date of this message boards category.
 void setMessageCount(int messageCount)
          Sets the message count of this message boards category.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this message boards category.
 void setName(String name)
          Sets the name of this message boards category.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentCategoryId(long parentCategoryId)
          Sets the parent category ID of this message boards category.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this message boards category.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setThreadCount(int threadCount)
          Sets the thread count of this message boards category.
 void setUserId(long userId)
          Sets the user ID of this message boards category.
 void setUserName(String userName)
          Sets the user name of this message boards category.
 void setUserUuid(String userUuid)
          Sets the user uuid of this message boards category.
 void setUuid(String uuid)
          Sets the uuid of this message boards category.
 CacheModel<MBCategory> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 MBCategory toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 MBCategory 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 category.

Returns:
the primary key of this message boards category

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this message boards category

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this message boards category.

Returns:
the uuid of this message boards category

setUuid

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

Parameters:
uuid - the uuid of this message boards category

getCategoryId

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

Returns:
the category ID of this message boards category

setCategoryId

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

Parameters:
categoryId - the category ID of this message boards category

getGroupId

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

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

setGroupId

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

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

getCompanyId

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

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this message boards category

setCompanyId

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

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

getUserId

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

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

setUserId

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

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

getUserUuid

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

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

setUserUuid

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

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

getUserName

@AutoEscape
String getUserName()
Returns the user name of this message boards category.

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

setUserName

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

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

getCreateDate

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

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this message boards category

setCreateDate

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

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

getModifiedDate

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

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this message boards category

setModifiedDate

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

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

getParentCategoryId

long getParentCategoryId()
Returns the parent category ID of this message boards category.

Returns:
the parent category ID of this message boards category

setParentCategoryId

void setParentCategoryId(long parentCategoryId)
Sets the parent category ID of this message boards category.

Parameters:
parentCategoryId - the parent category ID of this message boards category

getName

@AutoEscape
String getName()
Returns the name of this message boards category.

Returns:
the name of this message boards category

setName

void setName(String name)
Sets the name of this message boards category.

Parameters:
name - the name of this message boards category

getDescription

@AutoEscape
String getDescription()
Returns the description of this message boards category.

Returns:
the description of this message boards category

setDescription

void setDescription(String description)
Sets the description of this message boards category.

Parameters:
description - the description of this message boards category

getDisplayStyle

@AutoEscape
String getDisplayStyle()
Returns the display style of this message boards category.

Returns:
the display style of this message boards category

setDisplayStyle

void setDisplayStyle(String displayStyle)
Sets the display style of this message boards category.

Parameters:
displayStyle - the display style of this message boards category

getThreadCount

int getThreadCount()
Returns the thread count of this message boards category.

Returns:
the thread count of this message boards category

setThreadCount

void setThreadCount(int threadCount)
Sets the thread count of this message boards category.

Parameters:
threadCount - the thread count of this message boards category

getMessageCount

int getMessageCount()
Returns the message count of this message boards category.

Returns:
the message count of this message boards category

setMessageCount

void setMessageCount(int messageCount)
Sets the message count of this message boards category.

Parameters:
messageCount - the message count of this message boards category

getLastPostDate

Date getLastPostDate()
Returns the last post date of this message boards category.

Returns:
the last post date of this message boards category

setLastPostDate

void setLastPostDate(Date lastPostDate)
Sets the last post date of this message boards category.

Parameters:
lastPostDate - the last post date of this message boards category

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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
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<MBCategory>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(MBCategory mbCategory)
Specified by:
compareTo in interface Comparable<MBCategory>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

MBCategory toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<MBCategory>

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

Liferay 6.1.2-ce-ga3