Liferay 6.0-ee

com.liferay.portal.model
Interface EmailAddressModel

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

public interface EmailAddressModel
extends 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.

Never modify or reference this interface directly. All methods that expect a email address model instance should use the EmailAddress interface instead.

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()
          Gets the address of this email address.
 String getClassName()
          Gets the class name of the model instance this email address is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this email address.
 long getClassPK()
          Gets the class p k of this email address.
 long getCompanyId()
          Gets the company id of this email address.
 Date getCreateDate()
          Gets the create date of this email address.
 long getEmailAddressId()
          Gets the email address id of this email address.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 Date getModifiedDate()
          Gets the modified date of this email address.
 boolean getPrimary()
          Gets the primary of this email address.
 long getPrimaryKey()
          Gets the primary key of this email address.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int getTypeId()
          Gets the type id of this email address.
 long getUserId()
          Gets the user id of this email address.
 String getUserName()
          Gets the user name of this email address.
 String getUserUuid()
          Gets the user uuid of this email address.
 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.
 boolean isPrimary()
          Determines whether 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 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 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 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 {$entity.humanName} is primary.
 void setPrimaryKey(long pk)
          Sets the primary key of this email address
 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.
 EmailAddress toEscapedModel()
          Gets a copy of this entity 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 email address.

Returns:
the primary key of this email address

setPrimaryKey

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

Parameters:
pk - the primary key of this email address

getEmailAddressId

long getEmailAddressId()
Gets 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()
Gets the company id of this email address.

Returns:
the company id of this email address

setCompanyId

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

Parameters:
companyId - the company id of this email address

getUserId

long getUserId()
Gets the user id of this email address.

Returns:
the user id of this email address

setUserId

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

Parameters:
userId - the user id of this email address

getUserUuid

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

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.

Parameters:
userUuid - the user uuid of this email address

getUserName

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

Returns:
the user name of this email address

setUserName

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

Parameters:
userName - the user name of this email address

getCreateDate

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

Returns:
the create date of this email address

setCreateDate

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

Parameters:
createDate - the create date of this email address

getModifiedDate

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

Returns:
the modified date of this email address

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this email address

getClassName

String getClassName()
Gets the class name of the model instance this email address is polymorphically associated with.

Returns:
the class name of the model instance this email address is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name id of this email address.

Returns:
the class name id of this email address

setClassNameId

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

Parameters:
classNameId - the class name id of this email address

getClassPK

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

Returns:
the class p k of this email address

setClassPK

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

Parameters:
classPK - the class p k of this email address

getAddress

@AutoEscape
String getAddress()
Gets 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()
Gets 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()
Gets the primary of this email address.

Returns:
the primary of this email address

isPrimary

boolean isPrimary()
Determines whether this email address is primary.

Returns:
whether this email address is primary

setPrimary

void setPrimary(boolean primary)
Sets whether this {$entity.humanName} is primary.

Parameters:
primary - the primary of this email address

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

Specified by:
isEscapedModel in interface BaseModel<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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<EmailAddress>
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 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<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

toEscapedModel

EmailAddress toEscapedModel()
Description copied from interface: BaseModel
Gets 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

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

Liferay 6.0-ee