Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface EmailAddressModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<EmailAddress>, ClassedModel, Cloneable, Comparable<EmailAddress>, Serializable
All Known Subinterfaces:
EmailAddress
All Known Implementing Classes:
EmailAddressBaseImpl, EmailAddressImpl, EmailAddressModelImpl, EmailAddressWrapper

public interface EmailAddressModel
extends AttachedModel, AuditedModel, BaseModel<EmailAddress>

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

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

See Also:
EmailAddress, EmailAddressImpl, EmailAddressModelImpl
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(EmailAddress emailAddress)
           
 String getAddress()
          Returns the address of this email address.
 String getClassName()
          Returns the fully qualified class name of this email address.
 long getClassNameId()
          Returns the class name ID of this email address.
 long getClassPK()
          Returns the class p k of this email address.
 long getCompanyId()
          Returns the company ID of this email address.
 Date getCreateDate()
          Returns the create date of this email address.
 long getEmailAddressId()
          Returns the email address ID of this email address.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getModifiedDate()
          Returns the modified date of this email address.
 boolean getPrimary()
          Returns the primary of this email address.
 long getPrimaryKey()
          Returns the primary key of this email address.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getTypeId()
          Returns the type ID of this email address.
 long getUserId()
          Returns the user ID of this email address.
 String getUserName()
          Returns the user name of this email address.
 String getUserUuid()
          Returns the user uuid of this email address.
 int hashCode()
           
 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 isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPrimary()
          Returns true if this email address is primary.
 void setAddress(String address)
          Sets the address of this email address.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this email address.
 void setClassPK(long classPK)
          Sets the class p k of this email address.
 void setCompanyId(long companyId)
          Sets the company ID of this email address.
 void setCreateDate(Date createDate)
          Sets the create date of this email address.
 void setEmailAddressId(long emailAddressId)
          Sets the email address ID of this email address.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this email address.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimary(boolean primary)
          Sets whether this email address is primary.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this email address.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setTypeId(int typeId)
          Sets the type ID of this email address.
 void setUserId(long userId)
          Sets the user ID of this email address.
 void setUserName(String userName)
          Sets the user name of this email address.
 void setUserUuid(String userUuid)
          Sets the user uuid of this email address.
 CacheModel<EmailAddress> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 EmailAddress toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 EmailAddress 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 email address.

Returns:
the primary key of this email address

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this email address.

Parameters:
primaryKey - the primary key of this email address

getEmailAddressId

long getEmailAddressId()
Returns the email address ID of this email address.

Returns:
the email address ID of this email address

setEmailAddressId

void setEmailAddressId(long emailAddressId)
Sets the email address ID of this email address.

Parameters:
emailAddressId - the email address ID of this email address

getCompanyId

long getCompanyId()
Returns the company ID of this email address.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this email address

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this email address.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this email address

getUserId

long getUserId()
Returns the user ID of this email address.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this email address

setUserId

void setUserId(long userId)
Sets the user ID of this email address.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this email address

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this email address.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this email address
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this email address.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this email address

getUserName

@AutoEscape
String getUserName()
Returns the user name of this email address.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this email address

setUserName

void setUserName(String userName)
Sets the user name of this email address.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this email address

getCreateDate

Date getCreateDate()
Returns the create date of this email address.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this email address

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this email address.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this email address

getModifiedDate

Date getModifiedDate()
Returns the modified date of this email address.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this email address

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this email address.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this email address

getClassName

String getClassName()
Returns the fully qualified class name of this email address.

Specified by:
getClassName in interface AttachedModel
Returns:
the fully qualified class name of this email address

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this email address.

Specified by:
getClassNameId in interface AttachedModel
Returns:
the class name ID of this email address

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this email address.

Specified by:
setClassNameId in interface AttachedModel
Parameters:
classNameId - the class name ID of this email address

getClassPK

long getClassPK()
Returns the class p k of this email address.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this email address

setClassPK

void setClassPK(long classPK)
Sets the class p k of this email address.

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this email address

getAddress

@AutoEscape
String getAddress()
Returns the address of this email address.

Returns:
the address of this email address

setAddress

void setAddress(String address)
Sets the address of this email address.

Parameters:
address - the address of this email address

getTypeId

int getTypeId()
Returns the type ID of this email address.

Returns:
the type ID of this email address

setTypeId

void setTypeId(int typeId)
Sets the type ID of this email address.

Parameters:
typeId - the type ID of this email address

getPrimary

boolean getPrimary()
Returns the primary of this email address.

Returns:
the primary of this email address

isPrimary

boolean isPrimary()
Returns true if this email address is primary.

Returns:
true if this email address is primary; false otherwise

setPrimary

void setPrimary(boolean primary)
Sets whether this email address is primary.

Parameters:
primary - the primary of this email address

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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(EmailAddress emailAddress)
Specified by:
compareTo in interface Comparable<EmailAddress>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3