com.liferay.portlet.messageboards.model
Interface MBMailingListModel

All Superinterfaces:

BaseModel<MBMailingList>, Cloneable, Comparable<MBMailingList>, Serializable

All Known Subinterfaces:

MBMailingList

All Known Implementing Classes:

MBMailingListImpl, MBMailingListModelImpl, MBMailingListWrapper

public interface MBMailingListModel
extends BaseModel<MBMailingList>

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

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

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

See Also:

MBMailingList, MBMailingListImpl, MBMailingListModelImpl

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(MBMailingList mbMailingList)
boolean	getActive() Gets the active of this message boards mailing list.
long	getCategoryId() Gets the category id of this message boards mailing list.
long	getCompanyId() Gets the company id of this message boards mailing list.
Date	getCreateDate() Gets the create date of this message boards mailing list.
String	getEmailAddress() Gets the email address of this message boards mailing list.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this message boards mailing list.
String	getInPassword() Gets the in password of this message boards mailing list.
String	getInProtocol() Gets the in protocol of this message boards mailing list.
int	getInReadInterval() Gets the in read interval of this message boards mailing list.
String	getInServerName() Gets the in server name of this message boards mailing list.
int	getInServerPort() Gets the in server port of this message boards mailing list.
String	getInUserName() Gets the in user name of this message boards mailing list.
boolean	getInUseSSL() Gets the in use s s l of this message boards mailing list.
long	getMailingListId() Gets the mailing list id of this message boards mailing list.
Date	getModifiedDate() Gets the modified date of this message boards mailing list.
boolean	getOutCustom() Gets the out custom of this message boards mailing list.
String	getOutEmailAddress() Gets the out email address of this message boards mailing list.
String	getOutPassword() Gets the out password of this message boards mailing list.
String	getOutServerName() Gets the out server name of this message boards mailing list.
int	getOutServerPort() Gets the out server port of this message boards mailing list.
String	getOutUserName() Gets the out user name of this message boards mailing list.
boolean	getOutUseSSL() Gets the out use s s l of this message boards mailing list.
long	getPrimaryKey() Gets the primary key of this message boards mailing list.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this message boards mailing list.
String	getUserName() Gets the user name of this message boards mailing list.
String	getUserUuid() Gets the user uuid of this message boards mailing list.
String	getUuid() Gets the uuid of this message boards mailing list.
int	hashCode()
boolean	isActive() Determines whether this message boards mailing list is active.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isInUseSSL() Determines whether this message boards mailing list is in use s s l.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isOutCustom() Determines whether this message boards mailing list is out custom.
boolean	isOutUseSSL() Determines whether this message boards mailing list is out use s s l.
void	setActive(boolean active) Sets whether this {$entity.humanName} is active.
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 mailing list.
void	setCompanyId(long companyId) Sets the company id of this message boards mailing list.
void	setCreateDate(Date createDate) Sets the create date of this message boards mailing list.
void	setEmailAddress(String emailAddress) Sets the email address of this message boards mailing list.
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 mailing list.
void	setInPassword(String inPassword) Sets the in password of this message boards mailing list.
void	setInProtocol(String inProtocol) Sets the in protocol of this message boards mailing list.
void	setInReadInterval(int inReadInterval) Sets the in read interval of this message boards mailing list.
void	setInServerName(String inServerName) Sets the in server name of this message boards mailing list.
void	setInServerPort(int inServerPort) Sets the in server port of this message boards mailing list.
void	setInUserName(String inUserName) Sets the in user name of this message boards mailing list.
void	setInUseSSL(boolean inUseSSL) Sets whether this {$entity.humanName} is in use s s l.
void	setMailingListId(long mailingListId) Sets the mailing list id of this message boards mailing list.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this message boards mailing list.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setOutCustom(boolean outCustom) Sets whether this {$entity.humanName} is out custom.
void	setOutEmailAddress(String outEmailAddress) Sets the out email address of this message boards mailing list.
void	setOutPassword(String outPassword) Sets the out password of this message boards mailing list.
void	setOutServerName(String outServerName) Sets the out server name of this message boards mailing list.
void	setOutServerPort(int outServerPort) Sets the out server port of this message boards mailing list.
void	setOutUserName(String outUserName) Sets the out user name of this message boards mailing list.
void	setOutUseSSL(boolean outUseSSL) Sets whether this {$entity.humanName} is out use s s l.
void	setPrimaryKey(long pk) Sets the primary key of this message boards mailing list
void	setUserId(long userId) Sets the user id of this message boards mailing list.
void	setUserName(String userName) Sets the user name of this message boards mailing list.
void	setUserUuid(String userUuid) Sets the user uuid of this message boards mailing list.
void	setUuid(String uuid) Sets the uuid of this message boards mailing list.
MBMailingList	toEscapedModel() Gets a copy of this message boards mailing list 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 mailing list.

Returns:

the primary key of this message boards mailing list

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this message boards mailing list

Parameters:

pk - the primary key of this message boards mailing list

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this message boards mailing list.

Returns:

the uuid of this message boards mailing list

setUuid

void setUuid(String uuid)

Sets the uuid of this message boards mailing list.

Parameters:

uuid - the uuid of this message boards mailing list

getMailingListId

long getMailingListId()

Gets the mailing list id of this message boards mailing list.

Returns:

the mailing list id of this message boards mailing list

setMailingListId

void setMailingListId(long mailingListId)

Sets the mailing list id of this message boards mailing list.

Parameters:

mailingListId - the mailing list id of this message boards mailing list

getGroupId

long getGroupId()

Gets the group id of this message boards mailing list.

Returns:

the group id of this message boards mailing list

setGroupId

void setGroupId(long groupId)

Sets the group id of this message boards mailing list.

Parameters:

groupId - the group id of this message boards mailing list

getCompanyId

long getCompanyId()

Gets the company id of this message boards mailing list.

Returns:

the company id of this message boards mailing list

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this message boards mailing list.

Parameters:

companyId - the company id of this message boards mailing list

getUserId

long getUserId()

Gets the user id of this message boards mailing list.

Returns:

the user id of this message boards mailing list

setUserId

void setUserId(long userId)

Sets the user id of this message boards mailing list.

Parameters:

userId - the user id of this message boards mailing list

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this message boards mailing list.

Returns:

the user uuid of this message boards mailing list

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this message boards mailing list.

Parameters:

userUuid - the user uuid of this message boards mailing list

getUserName

@AutoEscape
String getUserName()

Gets the user name of this message boards mailing list.

Returns:

the user name of this message boards mailing list

setUserName

void setUserName(String userName)

Sets the user name of this message boards mailing list.

Parameters:

userName - the user name of this message boards mailing list

getCreateDate

Date getCreateDate()

Gets the create date of this message boards mailing list.

Returns:

the create date of this message boards mailing list

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this message boards mailing list.

Parameters:

createDate - the create date of this message boards mailing list

getModifiedDate

Date getModifiedDate()

Gets the modified date of this message boards mailing list.

Returns:

the modified date of this message boards mailing list

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this message boards mailing list.

Parameters:

modifiedDate - the modified date of this message boards mailing list

getCategoryId

long getCategoryId()

Gets the category id of this message boards mailing list.

Returns:

the category id of this message boards mailing list

setCategoryId

void setCategoryId(long categoryId)

Sets the category id of this message boards mailing list.

Parameters:

categoryId - the category id of this message boards mailing list

getEmailAddress

@AutoEscape
String getEmailAddress()

Gets the email address of this message boards mailing list.

Returns:

the email address of this message boards mailing list

setEmailAddress

void setEmailAddress(String emailAddress)

Sets the email address of this message boards mailing list.

Parameters:

emailAddress - the email address of this message boards mailing list

getInProtocol

@AutoEscape
String getInProtocol()

Gets the in protocol of this message boards mailing list.

Returns:

the in protocol of this message boards mailing list

setInProtocol

void setInProtocol(String inProtocol)

Sets the in protocol of this message boards mailing list.

Parameters:

inProtocol - the in protocol of this message boards mailing list

getInServerName

@AutoEscape
String getInServerName()

Gets the in server name of this message boards mailing list.

Returns:

the in server name of this message boards mailing list

setInServerName

void setInServerName(String inServerName)

Sets the in server name of this message boards mailing list.

Parameters:

inServerName - the in server name of this message boards mailing list

getInServerPort

int getInServerPort()

Gets the in server port of this message boards mailing list.

Returns:

the in server port of this message boards mailing list

setInServerPort

void setInServerPort(int inServerPort)

Sets the in server port of this message boards mailing list.

Parameters:

inServerPort - the in server port of this message boards mailing list

getInUseSSL

boolean getInUseSSL()

Gets the in use s s l of this message boards mailing list.

Returns:

the in use s s l of this message boards mailing list

isInUseSSL

boolean isInUseSSL()

Determines whether this message boards mailing list is in use s s l.

Returns:

whether this message boards mailing list is in use s s l

setInUseSSL

void setInUseSSL(boolean inUseSSL)

Sets whether this {$entity.humanName} is in use s s l.

Parameters:

inUseSSL - the in use s s l of this message boards mailing list

getInUserName

@AutoEscape
String getInUserName()

Gets the in user name of this message boards mailing list.

Returns:

the in user name of this message boards mailing list

setInUserName

void setInUserName(String inUserName)

Sets the in user name of this message boards mailing list.

Parameters:

inUserName - the in user name of this message boards mailing list

getInPassword

@AutoEscape
String getInPassword()

Gets the in password of this message boards mailing list.

Returns:

the in password of this message boards mailing list

setInPassword

void setInPassword(String inPassword)

Sets the in password of this message boards mailing list.

Parameters:

inPassword - the in password of this message boards mailing list

getInReadInterval

int getInReadInterval()

Gets the in read interval of this message boards mailing list.

Returns:

the in read interval of this message boards mailing list

setInReadInterval

void setInReadInterval(int inReadInterval)

Sets the in read interval of this message boards mailing list.

Parameters:

inReadInterval - the in read interval of this message boards mailing list

getOutEmailAddress

@AutoEscape
String getOutEmailAddress()

Gets the out email address of this message boards mailing list.

Returns:

the out email address of this message boards mailing list

setOutEmailAddress

void setOutEmailAddress(String outEmailAddress)

Sets the out email address of this message boards mailing list.

Parameters:

outEmailAddress - the out email address of this message boards mailing list

getOutCustom

boolean getOutCustom()

Gets the out custom of this message boards mailing list.

Returns:

the out custom of this message boards mailing list

isOutCustom

boolean isOutCustom()

Determines whether this message boards mailing list is out custom.

Returns:

whether this message boards mailing list is out custom

setOutCustom

void setOutCustom(boolean outCustom)

Sets whether this {$entity.humanName} is out custom.

Parameters:

outCustom - the out custom of this message boards mailing list

getOutServerName

@AutoEscape
String getOutServerName()

Gets the out server name of this message boards mailing list.

Returns:

the out server name of this message boards mailing list

setOutServerName

void setOutServerName(String outServerName)

Sets the out server name of this message boards mailing list.

Parameters:

outServerName - the out server name of this message boards mailing list

getOutServerPort

int getOutServerPort()

Gets the out server port of this message boards mailing list.

Returns:

the out server port of this message boards mailing list

setOutServerPort

void setOutServerPort(int outServerPort)

Sets the out server port of this message boards mailing list.

Parameters:

outServerPort - the out server port of this message boards mailing list

getOutUseSSL

boolean getOutUseSSL()

Gets the out use s s l of this message boards mailing list.

Returns:

the out use s s l of this message boards mailing list

isOutUseSSL

boolean isOutUseSSL()

Determines whether this message boards mailing list is out use s s l.

Returns:

whether this message boards mailing list is out use s s l

setOutUseSSL

void setOutUseSSL(boolean outUseSSL)

Sets whether this {$entity.humanName} is out use s s l.

Parameters:

outUseSSL - the out use s s l of this message boards mailing list

getOutUserName

@AutoEscape
String getOutUserName()

Gets the out user name of this message boards mailing list.

Returns:

the out user name of this message boards mailing list

setOutUserName

void setOutUserName(String outUserName)

Sets the out user name of this message boards mailing list.

Parameters:

outUserName - the out user name of this message boards mailing list

getOutPassword

@AutoEscape
String getOutPassword()

Gets the out password of this message boards mailing list.

Returns:

the out password of this message boards mailing list

setOutPassword

void setOutPassword(String outPassword)

Sets the out password of this message boards mailing list.

Parameters:

outPassword - the out password of this message boards mailing list

getActive

boolean getActive()

Gets the active of this message boards mailing list.

Returns:

the active of this message boards mailing list

isActive

boolean isActive()

Determines whether this message boards mailing list is active.

Returns:

whether this message boards mailing list is active

setActive

void setActive(boolean active)

Sets whether this {$entity.humanName} is active.

Parameters:

active - the active of this message boards mailing list

toEscapedModel

MBMailingList toEscapedModel()

Gets a copy of this message boards mailing list 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<MBMailingList>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(MBMailingList mbMailingList)

Specified by:

compareTo in interface Comparable<MBMailingList>

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

Returns:

the XML representation of this model instance