Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface AddressModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<Address>, ClassedModel, Cloneable, Comparable<Address>, Serializable
All Known Subinterfaces:
Address
All Known Implementing Classes:
AddressBaseImpl, AddressImpl, AddressModelImpl, AddressWrapper

public interface AddressModel
extends AttachedModel, AuditedModel, BaseModel<Address>

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

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

See Also:
Address, AddressImpl, AddressModelImpl
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(Address address)
           
 long getAddressId()
          Returns the address ID of this address.
 String getCity()
          Returns the city of this address.
 String getClassName()
          Returns the fully qualified class name of this address.
 long getClassNameId()
          Returns the class name ID of this address.
 long getClassPK()
          Returns the class p k of this address.
 long getCompanyId()
          Returns the company ID of this address.
 long getCountryId()
          Returns the country ID of this address.
 Date getCreateDate()
          Returns the create date of this address.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 boolean getMailing()
          Returns the mailing of this address.
 Date getModifiedDate()
          Returns the modified date of this address.
 boolean getPrimary()
          Returns the primary of this address.
 long getPrimaryKey()
          Returns the primary key of this address.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRegionId()
          Returns the region ID of this address.
 String getStreet1()
          Returns the street1 of this address.
 String getStreet2()
          Returns the street2 of this address.
 String getStreet3()
          Returns the street3 of this address.
 int getTypeId()
          Returns the type ID of this address.
 long getUserId()
          Returns the user ID of this address.
 String getUserName()
          Returns the user name of this address.
 String getUserUuid()
          Returns the user uuid of this address.
 String getZip()
          Returns the zip of this 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 isMailing()
          Returns true if this address is mailing.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPrimary()
          Returns true if this address is primary.
 void setAddressId(long addressId)
          Sets the address ID of this address.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCity(String city)
          Sets the city of this address.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this address.
 void setClassPK(long classPK)
          Sets the class p k of this address.
 void setCompanyId(long companyId)
          Sets the company ID of this address.
 void setCountryId(long countryId)
          Sets the country ID of this address.
 void setCreateDate(Date createDate)
          Sets the create date of this address.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setMailing(boolean mailing)
          Sets whether this address is mailing.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this address.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimary(boolean primary)
          Sets whether this address is primary.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this address.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRegionId(long regionId)
          Sets the region ID of this address.
 void setStreet1(String street1)
          Sets the street1 of this address.
 void setStreet2(String street2)
          Sets the street2 of this address.
 void setStreet3(String street3)
          Sets the street3 of this address.
 void setTypeId(int typeId)
          Sets the type ID of this address.
 void setUserId(long userId)
          Sets the user ID of this address.
 void setUserName(String userName)
          Sets the user name of this address.
 void setUserUuid(String userUuid)
          Sets the user uuid of this address.
 void setZip(String zip)
          Sets the zip of this address.
 CacheModel<Address> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Address toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Address 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 address.

Returns:
the primary key of this address

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this address

getAddressId

long getAddressId()
Returns the address ID of this address.

Returns:
the address ID of this address

setAddressId

void setAddressId(long addressId)
Sets the address ID of this address.

Parameters:
addressId - the address ID of this address

getCompanyId

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

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

setCompanyId

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

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

getUserId

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

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

setUserId

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

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

getUserUuid

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

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

setUserUuid

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

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

getUserName

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

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

setUserName

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

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

getCreateDate

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

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

setCreateDate

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

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

getModifiedDate

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

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

setModifiedDate

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

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

getClassName

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

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

setClassName

void setClassName(String className)

getClassNameId

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

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

setClassNameId

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

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

getClassPK

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

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

setClassPK

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

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

getStreet1

@AutoEscape
String getStreet1()
Returns the street1 of this address.

Returns:
the street1 of this address

setStreet1

void setStreet1(String street1)
Sets the street1 of this address.

Parameters:
street1 - the street1 of this address

getStreet2

@AutoEscape
String getStreet2()
Returns the street2 of this address.

Returns:
the street2 of this address

setStreet2

void setStreet2(String street2)
Sets the street2 of this address.

Parameters:
street2 - the street2 of this address

getStreet3

@AutoEscape
String getStreet3()
Returns the street3 of this address.

Returns:
the street3 of this address

setStreet3

void setStreet3(String street3)
Sets the street3 of this address.

Parameters:
street3 - the street3 of this address

getCity

@AutoEscape
String getCity()
Returns the city of this address.

Returns:
the city of this address

setCity

void setCity(String city)
Sets the city of this address.

Parameters:
city - the city of this address

getZip

@AutoEscape
String getZip()
Returns the zip of this address.

Returns:
the zip of this address

setZip

void setZip(String zip)
Sets the zip of this address.

Parameters:
zip - the zip of this address

getRegionId

long getRegionId()
Returns the region ID of this address.

Returns:
the region ID of this address

setRegionId

void setRegionId(long regionId)
Sets the region ID of this address.

Parameters:
regionId - the region ID of this address

getCountryId

long getCountryId()
Returns the country ID of this address.

Returns:
the country ID of this address

setCountryId

void setCountryId(long countryId)
Sets the country ID of this address.

Parameters:
countryId - the country ID of this address

getTypeId

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

Returns:
the type ID of this address

setTypeId

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

Parameters:
typeId - the type ID of this address

getMailing

boolean getMailing()
Returns the mailing of this address.

Returns:
the mailing of this address

isMailing

boolean isMailing()
Returns true if this address is mailing.

Returns:
true if this address is mailing; false otherwise

setMailing

void setMailing(boolean mailing)
Sets whether this address is mailing.

Parameters:
mailing - the mailing of this address

getPrimary

boolean getPrimary()
Returns the primary of this address.

Returns:
the primary of this address

isPrimary

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

Returns:
true if this address is primary; false otherwise

setPrimary

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

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

compareTo

int compareTo(Address address)
Specified by:
compareTo in interface Comparable<Address>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3