com.liferay.portlet.messageboards.model
Class MBCategoryWrapper

java.lang.Object
  com.liferay.portlet.messageboards.model.MBCategoryWrapper

All Implemented Interfaces:

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

public class MBCategoryWrapper
extends Object
implements MBCategory

This class is a wrapper for MBCategory.

See Also:

MBCategory, Serialized Form

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

Constructor Summary

MBCategoryWrapper(MBCategory mbCategory)

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(MBCategory mbCategory)
List<Long>	getAncestorCategoryIds()
List<MBCategory>	getAncestors()
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.
MBCategory	getWrappedMBCategory()
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.
boolean	isRoot()
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.

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MBCategoryWrapper

public MBCategoryWrapper(MBCategory mbCategory)

Method Detail

getPrimaryKey

public long getPrimaryKey()

Description copied from interface: MBCategoryModel

Gets the primary key of this message boards category.

Specified by:

getPrimaryKey in interface MBCategoryModel

Returns:

the primary key of this message boards category

setPrimaryKey

public void setPrimaryKey(long pk)

Description copied from interface: MBCategoryModel

Sets the primary key of this message boards category

Specified by:

setPrimaryKey in interface MBCategoryModel

Parameters:

pk - the primary key of this message boards category

getUuid

public String getUuid()

Description copied from interface: MBCategoryModel

Gets the uuid of this message boards category.

Specified by:

getUuid in interface MBCategoryModel

Returns:

the uuid of this message boards category

setUuid

public void setUuid(String uuid)

Description copied from interface: MBCategoryModel

Sets the uuid of this message boards category.

Specified by:

setUuid in interface MBCategoryModel

Parameters:

uuid - the uuid of this message boards category

getCategoryId

public long getCategoryId()

Description copied from interface: MBCategoryModel

Gets the category id of this message boards category.

Specified by:

getCategoryId in interface MBCategoryModel

Returns:

the category id of this message boards category

setCategoryId

public void setCategoryId(long categoryId)

Description copied from interface: MBCategoryModel

Sets the category id of this message boards category.

Specified by:

setCategoryId in interface MBCategoryModel

Parameters:

categoryId - the category id of this message boards category

getGroupId

public long getGroupId()

Description copied from interface: MBCategoryModel

Gets the group id of this message boards category.

Specified by:

getGroupId in interface MBCategoryModel

Returns:

the group id of this message boards category

setGroupId

public void setGroupId(long groupId)

Description copied from interface: MBCategoryModel

Sets the group id of this message boards category.

Specified by:

setGroupId in interface MBCategoryModel

Parameters:

groupId - the group id of this message boards category

getCompanyId

public long getCompanyId()

Description copied from interface: MBCategoryModel

Gets the company id of this message boards category.

Specified by:

getCompanyId in interface MBCategoryModel

Returns:

the company id of this message boards category

setCompanyId

public void setCompanyId(long companyId)

Description copied from interface: MBCategoryModel

Sets the company id of this message boards category.

Specified by:

setCompanyId in interface MBCategoryModel

Parameters:

companyId - the company id of this message boards category

getUserId

public long getUserId()

Description copied from interface: MBCategoryModel

Gets the user id of this message boards category.

Specified by:

getUserId in interface MBCategoryModel

Returns:

the user id of this message boards category

setUserId

public void setUserId(long userId)

Description copied from interface: MBCategoryModel

Sets the user id of this message boards category.

Specified by:

setUserId in interface MBCategoryModel

Parameters:

userId - the user id of this message boards category

getUserUuid

public String getUserUuid()
                   throws SystemException

Description copied from interface: MBCategoryModel

Gets the user uuid of this message boards category.

Specified by:

getUserUuid in interface MBCategoryModel

Returns:

the user uuid of this message boards category

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)

Description copied from interface: MBCategoryModel

Sets the user uuid of this message boards category.

Specified by:

setUserUuid in interface MBCategoryModel

Parameters:

userUuid - the user uuid of this message boards category

getUserName

public String getUserName()

Description copied from interface: MBCategoryModel

Gets the user name of this message boards category.

Specified by:

getUserName in interface MBCategoryModel

Returns:

the user name of this message boards category

setUserName

public void setUserName(String userName)

Description copied from interface: MBCategoryModel

Sets the user name of this message boards category.

Specified by:

setUserName in interface MBCategoryModel

Parameters:

userName - the user name of this message boards category

getCreateDate

public Date getCreateDate()

Description copied from interface: MBCategoryModel

Gets the create date of this message boards category.

Specified by:

getCreateDate in interface MBCategoryModel

Returns:

the create date of this message boards category

setCreateDate

public void setCreateDate(Date createDate)

Description copied from interface: MBCategoryModel

Sets the create date of this message boards category.

Specified by:

setCreateDate in interface MBCategoryModel

Parameters:

createDate - the create date of this message boards category

getModifiedDate

public Date getModifiedDate()

Description copied from interface: MBCategoryModel

Gets the modified date of this message boards category.

Specified by:

getModifiedDate in interface MBCategoryModel

Returns:

the modified date of this message boards category

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Description copied from interface: MBCategoryModel

Sets the modified date of this message boards category.

Specified by:

setModifiedDate in interface MBCategoryModel

Parameters:

modifiedDate - the modified date of this message boards category

getParentCategoryId

public long getParentCategoryId()

Description copied from interface: MBCategoryModel

Gets the parent category id of this message boards category.

Specified by:

getParentCategoryId in interface MBCategoryModel

Returns:

the parent category id of this message boards category

setParentCategoryId

public void setParentCategoryId(long parentCategoryId)

Description copied from interface: MBCategoryModel

Sets the parent category id of this message boards category.

Specified by:

setParentCategoryId in interface MBCategoryModel

Parameters:

parentCategoryId - the parent category id of this message boards category

getName

public String getName()

Description copied from interface: MBCategoryModel

Gets the name of this message boards category.

Specified by:

getName in interface MBCategoryModel

Returns:

the name of this message boards category

setName

public void setName(String name)

Description copied from interface: MBCategoryModel

Sets the name of this message boards category.

Specified by:

setName in interface MBCategoryModel

Parameters:

name - the name of this message boards category

getDescription

public String getDescription()

Description copied from interface: MBCategoryModel

Gets the description of this message boards category.

Specified by:

getDescription in interface MBCategoryModel

Returns:

the description of this message boards category

setDescription

public void setDescription(String description)

Description copied from interface: MBCategoryModel

Sets the description of this message boards category.

Specified by:

setDescription in interface MBCategoryModel

Parameters:

description - the description of this message boards category

getThreadCount

public int getThreadCount()

Description copied from interface: MBCategoryModel

Gets the thread count of this message boards category.

Specified by:

getThreadCount in interface MBCategoryModel

Returns:

the thread count of this message boards category

setThreadCount

public void setThreadCount(int threadCount)

Description copied from interface: MBCategoryModel

Sets the thread count of this message boards category.

Specified by:

setThreadCount in interface MBCategoryModel

Parameters:

threadCount - the thread count of this message boards category

getMessageCount

public int getMessageCount()

Description copied from interface: MBCategoryModel

Gets the message count of this message boards category.

Specified by:

getMessageCount in interface MBCategoryModel

Returns:

the message count of this message boards category

setMessageCount

public void setMessageCount(int messageCount)

Description copied from interface: MBCategoryModel

Sets the message count of this message boards category.

Specified by:

setMessageCount in interface MBCategoryModel

Parameters:

messageCount - the message count of this message boards category

getLastPostDate

public Date getLastPostDate()

Description copied from interface: MBCategoryModel

Gets the last post date of this message boards category.

Specified by:

getLastPostDate in interface MBCategoryModel

Returns:

the last post date of this message boards category

setLastPostDate

public void setLastPostDate(Date lastPostDate)

Description copied from interface: MBCategoryModel

Sets the last post date of this message boards category.

Specified by:

setLastPostDate in interface MBCategoryModel

Parameters:

lastPostDate - the last post date of this message boards category

toEscapedModel

public MBCategory toEscapedModel()

Description copied from interface: MBCategoryModel

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

Specified by:

toEscapedModel in interface MBCategoryModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

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

Specified by:

isNew in interface MBCategoryModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

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

Specified by:

setNew in interface MBCategoryModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

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

Specified by:

isCachedModel in interface MBCategoryModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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

Specified by:

setCachedModel in interface MBCategoryModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<MBCategory>

Specified by:

isEscapedModel in interface MBCategoryModel

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

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

Specified by:

setEscapedModel in interface MBCategoryModel

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<MBCategory>

Specified by:

getPrimaryKeyObj in interface MBCategoryModel

Returns:

the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<MBCategory>

Specified by:

getExpandoBridge in interface MBCategoryModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

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

Specified by:

setExpandoBridgeAttributes in interface MBCategoryModel

Parameters:

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

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<MBCategory>

Specified by:

clone in interface MBCategoryModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(MBCategory mbCategory)

Specified by:

compareTo in interface MBCategoryModel

Specified by:

compareTo in interface Comparable<MBCategory>

hashCode

public int hashCode()

Specified by:

hashCode in interface MBCategoryModel

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface MBCategoryModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<MBCategory>

Specified by:

toXmlString in interface MBCategoryModel

Returns:

the XML representation of this model instance

getAncestorCategoryIds

public List<Long> getAncestorCategoryIds()
                                  throws PortalException,
                                         SystemException

Specified by:

getAncestorCategoryIds in interface MBCategory

Throws:

PortalException

SystemException

getAncestors

public List<MBCategory> getAncestors()
                              throws PortalException,
                                     SystemException

Specified by:

getAncestors in interface MBCategory

Throws:

PortalException

SystemException

isRoot

public boolean isRoot()

Specified by:

isRoot in interface MBCategory

getWrappedMBCategory

public MBCategory getWrappedMBCategory()