Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Class AddressWrapper

java.lang.Object
  extended by com.liferay.portal.model.AddressWrapper
All Implemented Interfaces:
Address, AddressModel, AttachedModel, AuditedModel, BaseModel<Address>, ClassedModel, ModelWrapper<Address>, PersistedModel, Serializable, Cloneable, Comparable<Address>

public class AddressWrapper
extends Object
implements Address, ModelWrapper<Address>

This class is a wrapper for Address.

See Also:
Address, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
AddressWrapper(Address address)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Address address)
           
 boolean equals(Object obj)
           
 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.
 Country getCountry()
           
 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.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 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.
 Region getRegion()
           
 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.
 ListType getType()
           
 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.
 Address getWrappedAddress()
          Deprecated. Renamed to getWrappedModel()
 Address getWrappedModel()
           
 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 persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void resetOriginalValues()
          Reset all original fields to current values.
 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 setModelAttributes(Map<String,Object> attributes)
           
 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 class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AddressWrapper

public AddressWrapper(Address address)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<Address>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<Address>

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this address.

Specified by:
getPrimaryKey in interface AddressModel
Returns:
the primary key of this address

setPrimaryKey

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

Specified by:
setPrimaryKey in interface AddressModel
Parameters:
primaryKey - the primary key of this address

getAddressId

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

Specified by:
getAddressId in interface AddressModel
Returns:
the address ID of this address

setAddressId

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

Specified by:
setAddressId in interface AddressModel
Parameters:
addressId - the address ID of this address

getCompanyId

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

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

setCompanyId

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

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

getUserId

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

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

setUserId

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

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

getUserUuid

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

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

setUserUuid

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

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

getUserName

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

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

setUserName

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

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

getCreateDate

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

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

setCreateDate

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

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

getModifiedDate

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

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

setModifiedDate

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

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

getClassName

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

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

setClassName

public void setClassName(String className)
Specified by:
setClassName in interface AddressModel

getClassNameId

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

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

setClassNameId

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

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

getClassPK

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

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

setClassPK

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

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

getStreet1

public String getStreet1()
Returns the street1 of this address.

Specified by:
getStreet1 in interface AddressModel
Returns:
the street1 of this address

setStreet1

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

Specified by:
setStreet1 in interface AddressModel
Parameters:
street1 - the street1 of this address

getStreet2

public String getStreet2()
Returns the street2 of this address.

Specified by:
getStreet2 in interface AddressModel
Returns:
the street2 of this address

setStreet2

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

Specified by:
setStreet2 in interface AddressModel
Parameters:
street2 - the street2 of this address

getStreet3

public String getStreet3()
Returns the street3 of this address.

Specified by:
getStreet3 in interface AddressModel
Returns:
the street3 of this address

setStreet3

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

Specified by:
setStreet3 in interface AddressModel
Parameters:
street3 - the street3 of this address

getCity

public String getCity()
Returns the city of this address.

Specified by:
getCity in interface AddressModel
Returns:
the city of this address

setCity

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

Specified by:
setCity in interface AddressModel
Parameters:
city - the city of this address

getZip

public String getZip()
Returns the zip of this address.

Specified by:
getZip in interface AddressModel
Returns:
the zip of this address

setZip

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

Specified by:
setZip in interface AddressModel
Parameters:
zip - the zip of this address

getRegionId

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

Specified by:
getRegionId in interface AddressModel
Returns:
the region ID of this address

setRegionId

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

Specified by:
setRegionId in interface AddressModel
Parameters:
regionId - the region ID of this address

getCountryId

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

Specified by:
getCountryId in interface AddressModel
Returns:
the country ID of this address

setCountryId

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

Specified by:
setCountryId in interface AddressModel
Parameters:
countryId - the country ID of this address

getTypeId

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

Specified by:
getTypeId in interface AddressModel
Returns:
the type ID of this address

setTypeId

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

Specified by:
setTypeId in interface AddressModel
Parameters:
typeId - the type ID of this address

getMailing

public boolean getMailing()
Returns the mailing of this address.

Specified by:
getMailing in interface AddressModel
Returns:
the mailing of this address

isMailing

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

Specified by:
isMailing in interface AddressModel
Returns:
true if this address is mailing; false otherwise

setMailing

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

Specified by:
setMailing in interface AddressModel
Parameters:
mailing - the mailing of this address

getPrimary

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

Specified by:
getPrimary in interface AddressModel
Returns:
the primary of this address

isPrimary

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

Specified by:
isPrimary in interface AddressModel
Returns:
true if this address is primary; false otherwise

setPrimary

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

Specified by:
setPrimary in interface AddressModel
Parameters:
primary - the primary of this address

isNew

public 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 AddressModel
Specified by:
isNew in interface BaseModel<Address>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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 AddressModel
Specified by:
setNew in interface BaseModel<Address>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface AddressModel
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

public 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 AddressModel
Specified by:
setCachedModel in interface BaseModel<Address>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface AddressModel
Specified by:
isEscapedModel in interface BaseModel<Address>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface AddressModel
Specified by:
getPrimaryKeyObj in interface BaseModel<Address>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface AddressModel
Specified by:
setPrimaryKeyObj in interface BaseModel<Address>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface AddressModel
Specified by:
getExpandoBridge in interface BaseModel<Address>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public 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 AddressModel
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Address>
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface AddressModel
Specified by:
clone in interface BaseModel<Address>
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

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

hashCode

public int hashCode()
Specified by:
hashCode in interface AddressModel
Overrides:
hashCode in class Object

toCacheModel

public 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 AddressModel
Specified by:
toCacheModel in interface BaseModel<Address>
Returns:
the cache model object

toEscapedModel

public 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 AddressModel
Specified by:
toEscapedModel in interface BaseModel<Address>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

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

toString

public String toString()
Specified by:
toString in interface AddressModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface AddressModel
Specified by:
toXmlString in interface BaseModel<Address>
Returns:
the XML representation of this model instance

persist

public void persist()
             throws SystemException
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel
Throws:
SystemException - if a system exception occurred

getCountry

public Country getCountry()
Specified by:
getCountry in interface Address

getRegion

public Region getRegion()
Specified by:
getRegion in interface Address

getType

public ListType getType()
Specified by:
getType in interface Address

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedAddress

public Address getWrappedAddress()
Deprecated. Renamed to getWrappedModel()


getWrappedModel

public Address getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<Address>

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<Address>

Liferay 6.1.2-ce-ga3