com.liferay.portlet.messageboards.model
Interface MBCategoryModel

All Superinterfaces:

BaseModel<MBCategory>, Cloneable, Comparable<MBCategory>, Serializable

All Known Subinterfaces:

MBCategory

All Known Implementing Classes:

MBCategoryImpl, MBCategoryModelImpl, MBCategoryWrapper

public interface MBCategoryModel
extends BaseModel<MBCategory>

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.

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

See Also:

MBCategory, MBCategoryImpl, MBCategoryModelImpl

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(MBCategory mbCategory)
long	getCategoryId() Gets the category id of this message boards category.
long	getCompanyId() Gets the company id of this message boards category.
Date	getCreateDate() Gets the create date of this message boards category.
String	getDescription() Gets the description of this message boards category.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this message boards category.
Date	getLastPostDate() Gets the last post date of this message boards category.
int	getMessageCount() Gets the message count of this message boards category.
Date	getModifiedDate() Gets the modified date of this message boards category.
String	getName() Gets the name of this message boards category.
long	getParentCategoryId() Gets the parent category id of this message boards category.
long	getPrimaryKey() Gets the primary key of this message boards category.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
int	getThreadCount() Gets the thread count of this message boards category.
long	getUserId() Gets the user id of this message boards category.
String	getUserName() Gets the user name of this message boards category.
String	getUserUuid() Gets the user uuid of this message boards category.
String	getUuid() Gets the uuid of this message boards category.
int	hashCode()
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines 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	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 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 pk) Sets the primary key of this message boards category
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.
MBCategory	toEscapedModel() Gets a copy of this message boards category 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 category.

Returns:

the primary key of this message boards category

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this message boards category

Parameters:

pk - the primary key of this message boards category

getUuid

@AutoEscape
String getUuid()

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

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

Gets the group id of this message boards category.

Returns:

the group id of this message boards category

setGroupId

void setGroupId(long groupId)

Sets the group id of this message boards category.

Parameters:

groupId - the group id of this message boards category

getCompanyId

long getCompanyId()

Gets the company id of this message boards category.

Returns:

the company id of this message boards category

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this message boards category.

Parameters:

companyId - the company id of this message boards category

getUserId

long getUserId()

Gets the user id of this message boards category.

Returns:

the user id of this message boards category

setUserId

void setUserId(long userId)

Sets the user id of this message boards category.

Parameters:

userId - the user id of this message boards category

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this message boards category.

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.

Parameters:

userUuid - the user uuid of this message boards category

getUserName

@AutoEscape
String getUserName()

Gets the user name of this message boards category.

Returns:

the user name of this message boards category

setUserName

void setUserName(String userName)

Sets the user name of this message boards category.

Parameters:

userName - the user name of this message boards category

getCreateDate

Date getCreateDate()

Gets the create date of this message boards category.

Returns:

the create date of this message boards category

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this message boards category.

Parameters:

createDate - the create date of this message boards category

getModifiedDate

Date getModifiedDate()

Gets the modified date of this message boards category.

Returns:

the modified date of this message boards category

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this message boards category.

Parameters:

modifiedDate - the modified date of this message boards category

getParentCategoryId

long getParentCategoryId()

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

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

Gets 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

getThreadCount

int getThreadCount()

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

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

Gets 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

toEscapedModel

MBCategory toEscapedModel()

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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<MBCategory>

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

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

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

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

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

Returns:

the XML representation of this model instance