com.liferay.portlet.messageboards.model
Interface MBBanModel

All Superinterfaces:

BaseModel<MBBan>, Cloneable, Comparable<MBBan>, Serializable

All Known Subinterfaces:

MBBan

All Known Implementing Classes:

MBBanImpl, MBBanModelImpl, MBBanWrapper

public interface MBBanModel
extends BaseModel<MBBan>

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

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

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

See Also:

MBBan, MBBanImpl, MBBanModelImpl

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(MBBan mbBan)
long	getBanId() Gets the ban id of this message boards ban.
long	getBanUserId() Gets the ban user id of this message boards ban.
String	getBanUserUuid() Gets the ban user uuid of this message boards ban.
long	getCompanyId() Gets the company id of this message boards ban.
Date	getCreateDate() Gets the create date of this message boards ban.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this message boards ban.
Date	getModifiedDate() Gets the modified date of this message boards ban.
long	getPrimaryKey() Gets the primary key of this message boards ban.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this message boards ban.
String	getUserName() Gets the user name of this message boards ban.
String	getUserUuid() Gets the user uuid of this message boards ban.
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	setBanId(long banId) Sets the ban id of this message boards ban.
void	setBanUserId(long banUserId) Sets the ban user id of this message boards ban.
void	setBanUserUuid(String banUserUuid) Sets the ban user uuid of this message boards ban.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCompanyId(long companyId) Sets the company id of this message boards ban.
void	setCreateDate(Date createDate) Sets the create date of this message boards ban.
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 ban.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this message boards ban.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this message boards ban
void	setUserId(long userId) Sets the user id of this message boards ban.
void	setUserName(String userName) Sets the user name of this message boards ban.
void	setUserUuid(String userUuid) Sets the user uuid of this message boards ban.
MBBan	toEscapedModel() Gets a copy of this message boards ban 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 ban.

Returns:

the primary key of this message boards ban

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this message boards ban

Parameters:

pk - the primary key of this message boards ban

getBanId

long getBanId()

Gets the ban id of this message boards ban.

Returns:

the ban id of this message boards ban

setBanId

void setBanId(long banId)

Sets the ban id of this message boards ban.

Parameters:

banId - the ban id of this message boards ban

getGroupId

long getGroupId()

Gets the group id of this message boards ban.

Returns:

the group id of this message boards ban

setGroupId

void setGroupId(long groupId)

Sets the group id of this message boards ban.

Parameters:

groupId - the group id of this message boards ban

getCompanyId

long getCompanyId()

Gets the company id of this message boards ban.

Returns:

the company id of this message boards ban

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this message boards ban.

Parameters:

companyId - the company id of this message boards ban

getUserId

long getUserId()

Gets the user id of this message boards ban.

Returns:

the user id of this message boards ban

setUserId

void setUserId(long userId)

Sets the user id of this message boards ban.

Parameters:

userId - the user id of this message boards ban

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this message boards ban.

Returns:

the user uuid of this message boards ban

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this message boards ban.

Parameters:

userUuid - the user uuid of this message boards ban

getUserName

@AutoEscape
String getUserName()

Gets the user name of this message boards ban.

Returns:

the user name of this message boards ban

setUserName

void setUserName(String userName)

Sets the user name of this message boards ban.

Parameters:

userName - the user name of this message boards ban

getCreateDate

Date getCreateDate()

Gets the create date of this message boards ban.

Returns:

the create date of this message boards ban

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this message boards ban.

Parameters:

createDate - the create date of this message boards ban

getModifiedDate

Date getModifiedDate()

Gets the modified date of this message boards ban.

Returns:

the modified date of this message boards ban

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this message boards ban.

Parameters:

modifiedDate - the modified date of this message boards ban

getBanUserId

long getBanUserId()

Gets the ban user id of this message boards ban.

Returns:

the ban user id of this message boards ban

setBanUserId

void setBanUserId(long banUserId)

Sets the ban user id of this message boards ban.

Parameters:

banUserId - the ban user id of this message boards ban

getBanUserUuid

String getBanUserUuid()
                      throws SystemException

Gets the ban user uuid of this message boards ban.

Returns:

the ban user uuid of this message boards ban

Throws:

SystemException - if a system exception occurred

setBanUserUuid

void setBanUserUuid(String banUserUuid)

Sets the ban user uuid of this message boards ban.

Parameters:

banUserUuid - the ban user uuid of this message boards ban

toEscapedModel

MBBan toEscapedModel()

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

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(MBBan mbBan)

Specified by:

compareTo in interface Comparable<MBBan>

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

Returns:

the XML representation of this model instance