com.liferay.portlet.messageboards.model
Interface MBCategoryModel

All Superinterfaces:

AuditedModel, BaseModel<MBCategory>, ClassedModel, Cloneable, Comparable<MBCategory>, ContainerModel, GroupedModel, Serializable, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel

All Known Subinterfaces:

MBCategory

All Known Implementing Classes:

MBCategoryWrapper

@ProviderType
public interface MBCategoryModel
extends BaseModel<MBCategory>, ContainerModel, StagedGroupedModel, TrashedModel, WorkflowedModel

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)
boolean	getApproved() Deprecated. As of 6.1.0, replaced by isApproved()
long	getCategoryId() Returns the category ID of this message boards category.
long	getCompanyId() Returns the company ID of this message boards category.
long	getContainerModelId() Returns the container model ID of this message boards category.
String	getContainerModelName() Returns the container name 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	getParentContainerModelId() Returns the parent container model 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	getStatus() Returns the status of this message boards category.
long	getStatusByUserId() Returns the status by user ID of this message boards category.
String	getStatusByUserName() Returns the status by user name of this message boards category.
String	getStatusByUserUuid() Returns the status by user uuid of this message boards category.
Date	getStatusDate() Returns the status date of this message boards category.
int	getThreadCount() Returns the thread count of this message boards category.
TrashEntry	getTrashEntry() Returns the trash entry created when this message boards category was moved to the Recycle Bin.
long	getTrashEntryClassPK() Returns the class primary key of the trash entry for this message boards category.
TrashHandler	getTrashHandler() Returns the trash handler for 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	isApproved() Returns true if this message boards category is approved.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isDenied() Returns true if this message boards category is denied.
boolean	isDraft() Returns true if this message boards category is a draft.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isExpired() Returns true if this message boards category is expired.
boolean	isInactive() Returns true if this message boards category is inactive.
boolean	isIncomplete() Returns true if this message boards category is incomplete.
boolean	isInTrash() Returns true if this message boards category is in the Recycle Bin.
boolean	isInTrashContainer() Returns true if the parent of this message boards category is in the Recycle Bin.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isPending() Returns true if this message boards category is pending.
boolean	isScheduled() Returns true if this message boards category is scheduled.
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	setContainerModelId(long containerModelId) Sets the container model 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(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
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	setParentContainerModelId(long parentContainerModelId) Sets the parent container model 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	setStatus(int status) Sets the status of this message boards category.
void	setStatusByUserId(long statusByUserId) Sets the status by user ID of this message boards category.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this message boards category.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this message boards category.
void	setStatusDate(Date statusDate) Sets the status date 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.
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.ContainerModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.StagedModel

getStagedModelType

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.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this message boards category

setUuid

void setUuid(String uuid)

Sets the uuid of this message boards category.

Specified by:

setUuid in interface StagedModel

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

Specified by:

getCompanyId in interface StagedModel

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

Specified by:

setCompanyId in interface StagedModel

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

Specified by:

getCreateDate in interface StagedModel

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

Specified by:

setCreateDate in interface StagedModel

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

Specified by:

getModifiedDate in interface StagedModel

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

Specified by:

setModifiedDate in interface StagedModel

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

getStatus

int getStatus()

Returns the status of this message boards category.

Specified by:

getStatus in interface TrashedModel

Specified by:

getStatus in interface WorkflowedModel

Returns:

the status of this message boards category

setStatus

void setStatus(int status)

Sets the status of this message boards category.

Specified by:

setStatus in interface WorkflowedModel

Parameters:

status - the status of this message boards category

getStatusByUserId

long getStatusByUserId()

Returns the status by user ID of this message boards category.

Specified by:

getStatusByUserId in interface WorkflowedModel

Returns:

the status by user ID of this message boards category

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user ID of this message boards category.

Specified by:

setStatusByUserId in interface WorkflowedModel

Parameters:

statusByUserId - the status by user ID of this message boards category

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Returns the status by user uuid of this message boards category.

Specified by:

getStatusByUserUuid in interface WorkflowedModel

Returns:

the status by user uuid of this message boards category

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

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

Specified by:

setStatusByUserUuid in interface WorkflowedModel

Parameters:

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

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Returns the status by user name of this message boards category.

Specified by:

getStatusByUserName in interface WorkflowedModel

Returns:

the status by user name of this message boards category

setStatusByUserName

void setStatusByUserName(String statusByUserName)

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

Specified by:

setStatusByUserName in interface WorkflowedModel

Parameters:

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

getStatusDate

Date getStatusDate()

Returns the status date of this message boards category.

Specified by:

getStatusDate in interface WorkflowedModel

Returns:

the status date of this message boards category

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this message boards category.

Specified by:

setStatusDate in interface WorkflowedModel

Parameters:

statusDate - the status date of this message boards category

getTrashEntry

TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException

Returns the trash entry created when this message boards category was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this message boards category.

Specified by:

getTrashEntry in interface TrashedModel

Returns:

the trash entry created when this message boards category was moved to the Recycle Bin

Throws:

SystemException - if a system exception occurred

PortalException

getTrashEntryClassPK

long getTrashEntryClassPK()

Returns the class primary key of the trash entry for this message boards category.

Specified by:

getTrashEntryClassPK in interface TrashedModel

Returns:

the class primary key of the trash entry for this message boards category

getTrashHandler

TrashHandler getTrashHandler()

Returns the trash handler for this message boards category.

Specified by:

getTrashHandler in interface TrashedModel

Returns:

the trash handler for this message boards category

isInTrash

boolean isInTrash()

Returns true if this message boards category is in the Recycle Bin.

Specified by:

isInTrash in interface TrashedModel

Returns:

true if this message boards category is in the Recycle Bin; false otherwise

isInTrashContainer

boolean isInTrashContainer()

Returns true if the parent of this message boards category is in the Recycle Bin.

Specified by:

isInTrashContainer in interface TrashedModel

Returns:

true if the parent of this message boards category is in the Recycle Bin; false otherwise

Throws:

SystemException - if a system exception occurred

getApproved

boolean getApproved()

Deprecated. As of 6.1.0, replaced by isApproved()

Specified by:

getApproved in interface WorkflowedModel

isApproved

boolean isApproved()

Returns true if this message boards category is approved.

Specified by:

isApproved in interface WorkflowedModel

Returns:

true if this message boards category is approved; false otherwise

isDenied

boolean isDenied()

Returns true if this message boards category is denied.

Specified by:

isDenied in interface WorkflowedModel

Returns:

true if this message boards category is denied; false otherwise

isDraft

boolean isDraft()

Returns true if this message boards category is a draft.

Specified by:

isDraft in interface WorkflowedModel

Returns:

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

isExpired

boolean isExpired()

Returns true if this message boards category is expired.

Specified by:

isExpired in interface WorkflowedModel

Returns:

true if this message boards category is expired; false otherwise

isInactive

boolean isInactive()

Returns true if this message boards category is inactive.

Specified by:

isInactive in interface WorkflowedModel

Returns:

true if this message boards category is inactive; false otherwise

isIncomplete

boolean isIncomplete()

Returns true if this message boards category is incomplete.

Specified by:

isIncomplete in interface WorkflowedModel

Returns:

true if this message boards category is incomplete; false otherwise

isPending

boolean isPending()

Returns true if this message boards category is pending.

Specified by:

isPending in interface WorkflowedModel

Returns:

true if this message boards category is pending; false otherwise

isScheduled

boolean isScheduled()

Returns true if this message boards category is scheduled.

Specified by:

isScheduled in interface WorkflowedModel

Returns:

true if this message boards category is scheduled; false otherwise

getContainerModelId

long getContainerModelId()

Returns the container model ID of this message boards category.

Specified by:

getContainerModelId in interface ContainerModel

Returns:

the container model ID of this message boards category

setContainerModelId

void setContainerModelId(long containerModelId)

Sets the container model ID of this message boards category.

Specified by:

setContainerModelId in interface ContainerModel

Parameters:

containerModelId - the container model ID of this message boards category

getContainerModelName

String getContainerModelName()

Returns the container name of this message boards category.

Specified by:

getContainerModelName in interface ContainerModel

Returns:

the container name of this message boards category

getParentContainerModelId

long getParentContainerModelId()

Returns the parent container model ID of this message boards category.

Specified by:

getParentContainerModelId in interface ContainerModel

Returns:

the parent container model ID of this message boards category

setParentContainerModelId

void setParentContainerModelId(long parentContainerModelId)

Sets the parent container model ID of this message boards category.

Specified by:

setParentContainerModelId in interface ContainerModel

Parameters:

parentContainerModelId - the parent container model ID 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(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<MBCategory>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<MBCategory>

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

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>

Specified by:

clone in interface StagedModel

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