com.liferay.portal.model
Interface AddressModel

All Superinterfaces:

BaseModel<Address>, Cloneable, Comparable<Address>, Serializable

All Known Subinterfaces:

Address

All Known Implementing Classes:

AddressImpl, AddressModelImpl, AddressWrapper

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

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

See Also:

Address, AddressImpl, AddressModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Address address)
long	getAddressId() Gets the address id of this address.
String	getCity() Gets the city of this address.
String	getClassName() Gets the class name of the model instance this address is polymorphically associated with.
long	getClassNameId() Gets the class name id of this address.
long	getClassPK() Gets the class p k of this address.
long	getCompanyId() Gets the company id of this address.
long	getCountryId() Gets the country id of this address.
Date	getCreateDate() Gets the create date of this address.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
boolean	getMailing() Gets the mailing of this address.
Date	getModifiedDate() Gets the modified date of this address.
boolean	getPrimary() Gets the primary of this address.
long	getPrimaryKey() Gets the primary key of this address.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getRegionId() Gets the region id of this address.
String	getStreet1() Gets the street1 of this address.
String	getStreet2() Gets the street2 of this address.
String	getStreet3() Gets the street3 of this address.
int	getTypeId() Gets the type id of this address.
long	getUserId() Gets the user id of this address.
String	getUserName() Gets the user name of this address.
String	getUserUuid() Gets the user uuid of this address.
String	getZip() Gets the zip of this 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	isMailing() Determines whether this address is mailing.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPrimary() Determines whether 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	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	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	setMailing(boolean mailing) Sets whether this {$entity.humanName} 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 {$entity.humanName} is primary.
void	setPrimaryKey(long pk) Sets the primary key of this address
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.
Address	toEscapedModel() Gets a copy of this address 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 address.

Returns:

the primary key of this address

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this address

Parameters:

pk - the primary key of this address

getAddressId

long getAddressId()

Gets 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()

Gets the company id of this address.

Returns:

the company id of this address

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this address.

Parameters:

companyId - the company id of this address

getUserId

long getUserId()

Gets the user id of this address.

Returns:

the user id of this address

setUserId

void setUserId(long userId)

Sets the user id of this address.

Parameters:

userId - the user id of this address

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this address.

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.

Parameters:

userUuid - the user uuid of this address

getUserName

@AutoEscape
String getUserName()

Gets the user name of this address.

Returns:

the user name of this address

setUserName

void setUserName(String userName)

Sets the user name of this address.

Parameters:

userName - the user name of this address

getCreateDate

Date getCreateDate()

Gets the create date of this address.

Returns:

the create date of this address

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this address.

Parameters:

createDate - the create date of this address

getModifiedDate

Date getModifiedDate()

Gets the modified date of this address.

Returns:

the modified date of this address

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this address.

Parameters:

modifiedDate - the modified date of this address

getClassName

String getClassName()

Gets the class name of the model instance this address is polymorphically associated with.

Returns:

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

getClassNameId

long getClassNameId()

Gets the class name id of this address.

Returns:

the class name id of this address

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this address.

Parameters:

classNameId - the class name id of this address

getClassPK

long getClassPK()

Gets the class p k of this address.

Returns:

the class p k of this address

setClassPK

void setClassPK(long classPK)

Sets the class p k of this address.

Parameters:

classPK - the class p k of this address

getStreet1

@AutoEscape
String getStreet1()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets the mailing of this address.

Returns:

the mailing of this address

isMailing

boolean isMailing()

Determines whether this address is mailing.

Returns:

whether this address is mailing

setMailing

void setMailing(boolean mailing)

Sets whether this {$entity.humanName} is mailing.

Parameters:

mailing - the mailing of this address

getPrimary

boolean getPrimary()

Gets the primary of this address.

Returns:

the primary of this address

isPrimary

boolean isPrimary()

Determines whether this address is primary.

Returns:

whether this address is primary

setPrimary

void setPrimary(boolean primary)

Sets whether this {$entity.humanName} is primary.

Parameters:

primary - the primary of this address

toEscapedModel

Address toEscapedModel()

Gets a copy of this address as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Address>

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<Address>

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<Address>

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<Address>

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 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<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

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<Address>

Returns:

the XML representation of this model instance