Liferay 6.1.2-ce-ga3

com.liferay.portlet.messageboards.model
Interface MBMailingListModel

All Superinterfaces:
AuditedModel, BaseModel<MBMailingList>, ClassedModel, Cloneable, Comparable<MBMailingList>, GroupedModel, Serializable
All Known Subinterfaces:
MBMailingList
All Known Implementing Classes:
MBMailingListBaseImpl, MBMailingListImpl, MBMailingListModelImpl, MBMailingListWrapper

public interface MBMailingListModel
extends BaseModel<MBMailingList>, GroupedModel

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.

See Also:
MBMailingList, MBMailingListImpl, MBMailingListModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(MBMailingList mbMailingList)
           
 boolean getActive()
          Returns the active of this message boards mailing list.
 boolean getAllowAnonymous()
          Returns the allow anonymous of this message boards mailing list.
 long getCategoryId()
          Returns the category ID of this message boards mailing list.
 long getCompanyId()
          Returns the company ID of this message boards mailing list.
 Date getCreateDate()
          Returns the create date of this message boards mailing list.
 String getEmailAddress()
          Returns the email address of this message boards mailing list.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this message boards mailing list.
 String getInPassword()
          Returns the in password of this message boards mailing list.
 String getInProtocol()
          Returns the in protocol of this message boards mailing list.
 int getInReadInterval()
          Returns the in read interval of this message boards mailing list.
 String getInServerName()
          Returns the in server name of this message boards mailing list.
 int getInServerPort()
          Returns the in server port of this message boards mailing list.
 String getInUserName()
          Returns the in user name of this message boards mailing list.
 boolean getInUseSSL()
          Returns the in use s s l of this message boards mailing list.
 long getMailingListId()
          Returns the mailing list ID of this message boards mailing list.
 Date getModifiedDate()
          Returns the modified date of this message boards mailing list.
 boolean getOutCustom()
          Returns the out custom of this message boards mailing list.
 String getOutEmailAddress()
          Returns the out email address of this message boards mailing list.
 String getOutPassword()
          Returns the out password of this message boards mailing list.
 String getOutServerName()
          Returns the out server name of this message boards mailing list.
 int getOutServerPort()
          Returns the out server port of this message boards mailing list.
 String getOutUserName()
          Returns the out user name of this message boards mailing list.
 boolean getOutUseSSL()
          Returns the out use s s l of this message boards mailing list.
 long getPrimaryKey()
          Returns the primary key of this message boards mailing list.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getUserId()
          Returns the user ID of this message boards mailing list.
 String getUserName()
          Returns the user name of this message boards mailing list.
 String getUserUuid()
          Returns the user uuid of this message boards mailing list.
 String getUuid()
          Returns the uuid of this message boards mailing list.
 int hashCode()
           
 boolean isActive()
          Returns true if this message boards mailing list is active.
 boolean isAllowAnonymous()
          Returns true if this message boards mailing list is allow anonymous.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isInUseSSL()
          Returns true if this message boards mailing list is in use s s l.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isOutCustom()
          Returns true if this message boards mailing list is out custom.
 boolean isOutUseSSL()
          Returns true if this message boards mailing list is out use s s l.
 void setActive(boolean active)
          Sets whether this message boards mailing list is active.
 void setAllowAnonymous(boolean allowAnonymous)
          Sets whether this message boards mailing list is allow anonymous.
 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 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 message boards mailing list 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 message boards mailing list 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 message boards mailing list is out use s s l.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this message boards mailing list.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 CacheModel<MBMailingList> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 MBMailingList toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 MBMailingList 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.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this message boards mailing list.

Returns:
the primary key of this message boards mailing list

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this message boards mailing list.

Parameters:
primaryKey - the primary key of this message boards mailing list

getUuid

@AutoEscape
String getUuid()
Returns 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()
Returns 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()
Returns the group ID of this message boards mailing list.

Specified by:
getGroupId in interface GroupedModel
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.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this message boards mailing list

getCompanyId

long getCompanyId()
Returns the company ID of this message boards mailing list.

Specified by:
getCompanyId in interface AuditedModel
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.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this message boards mailing list

getUserId

long getUserId()
Returns the user ID of this message boards mailing list.

Specified by:
getUserId in interface AuditedModel
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.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this message boards mailing list

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this message boards mailing list.

Specified by:
getUserUuid in interface AuditedModel
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.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this message boards mailing list

getUserName

@AutoEscape
String getUserName()
Returns the user name of this message boards mailing list.

Specified by:
getUserName in interface AuditedModel
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.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this message boards mailing list

getCreateDate

Date getCreateDate()
Returns the create date of this message boards mailing list.

Specified by:
getCreateDate in interface AuditedModel
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.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this message boards mailing list

getModifiedDate

Date getModifiedDate()
Returns the modified date of this message boards mailing list.

Specified by:
getModifiedDate in interface AuditedModel
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.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this message boards mailing list

getCategoryId

long getCategoryId()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns true if this message boards mailing list is in use s s l.

Returns:
true if this message boards mailing list is in use s s l; false otherwise

setInUseSSL

void setInUseSSL(boolean inUseSSL)
Sets whether this message boards mailing list is in use s s l.

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

getInUserName

@AutoEscape
String getInUserName()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns the out custom of this message boards mailing list.

Returns:
the out custom of this message boards mailing list

isOutCustom

boolean isOutCustom()
Returns true if this message boards mailing list is out custom.

Returns:
true if this message boards mailing list is out custom; false otherwise

setOutCustom

void setOutCustom(boolean outCustom)
Sets whether this message boards mailing list is out custom.

Parameters:
outCustom - the out custom of this message boards mailing list

getOutServerName

@AutoEscape
String getOutServerName()
Returns 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()
Returns 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()
Returns 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()
Returns true if this message boards mailing list is out use s s l.

Returns:
true if this message boards mailing list is out use s s l; false otherwise

setOutUseSSL

void setOutUseSSL(boolean outUseSSL)
Sets whether this message boards mailing list is out use s s l.

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

getOutUserName

@AutoEscape
String getOutUserName()
Returns 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()
Returns 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

getAllowAnonymous

boolean getAllowAnonymous()
Returns the allow anonymous of this message boards mailing list.

Returns:
the allow anonymous of this message boards mailing list

isAllowAnonymous

boolean isAllowAnonymous()
Returns true if this message boards mailing list is allow anonymous.

Returns:
true if this message boards mailing list is allow anonymous; false otherwise

setAllowAnonymous

void setAllowAnonymous(boolean allowAnonymous)
Sets whether this message boards mailing list is allow anonymous.

Parameters:
allowAnonymous - the allow anonymous of this message boards mailing list

getActive

boolean getActive()
Returns the active of this message boards mailing list.

Returns:
the active of this message boards mailing list

isActive

boolean isActive()
Returns true if this message boards mailing list is active.

Returns:
true if this message boards mailing list is active; false otherwise

setActive

void setActive(boolean active)
Sets whether this message boards mailing list is active.

Parameters:
active - the active of this message boards mailing list

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<MBMailingList>
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<MBMailingList>
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<MBMailingList>
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<MBMailingList>
Specified by:
getExpandoBridge in interface ClassedModel
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
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

toCacheModel

CacheModel<MBMailingList> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<MBMailingList>
Returns:
the cache model object

toEscapedModel

MBMailingList 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<MBMailingList>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

MBMailingList toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<MBMailingList>

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<MBMailingList>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3