com.elasticpath.domain.customer
Interface Address

All Superinterfaces:

EpDomain, Persistence, java.io.Serializable, ValueObject

All Known Subinterfaces:

CustomerAddress, OrderAddress

All Known Implementing Classes:

AbstractAddressImpl, CustomerAddressImpl, OrderAddressImpl

public interface Address
extends ValueObject

Address represents a North American address.

Method Summary

java.lang.String	getCity() Gets the city of this Address.
java.lang.String	getCountry() Gets the country of this Address.
java.lang.String	getFaxNumber() Gets the fax number associated with this Address.
java.lang.String	getFirstName() Gets the first name associated with this Address.
java.lang.String	getGuid() Return the guid.
java.lang.String	getLastName() Gets the last name associated with this Address.
java.lang.String	getPhoneNumber() Gets the phone number associated with this Address.
java.lang.String	getRegionPathStr() Return the string reprents the address's region path info, starting from city.
java.lang.String	getStreet1() Gets the streetname of this Address.
java.lang.String	getStreet2() Gets the streetname of this Address.
java.lang.String	getSubCountry() Gets the state, province, or other region of the country for this Address.
java.lang.String	getZipOrPostalCode() Gets the zip/postal code of this Address.
boolean	isCommercialAddress() True if this Address is a commercial address.
void	setCity(java.lang.String city) Sets the city of this Address.
void	setCommercialAddress(boolean commercialAddress) Sets whether this Address is a commercial address.
void	setCountry(java.lang.String country) Sets the country of this Address.
void	setFaxNumber(java.lang.String faxNumber) Sets the fax number associated with this Address.
void	setFirstName(java.lang.String firstName) Sets the first name associated with this Address.
void	setGuid(java.lang.String guid) Set the guid.
void	setLastName(java.lang.String lastName) Sets the last name associated with this Address.
void	setPhoneNumber(java.lang.String phoneNumber) Sets the phone number associated with this Address.
void	setStreet1(java.lang.String street) Sets the streetname of this Address.
void	setStreet2(java.lang.String street) Sets the streetname of this Address.
void	setSubCountry(java.lang.String subCountry) Sets the state, province, or other region of the country for this Address.
void	setZipOrPostalCode(java.lang.String zipOrPostalCode) Sets the zip/postal code of this Address.

Methods inherited from interface com.elasticpath.domain.Persistence

executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Method Detail

getCity

java.lang.String getCity()

Gets the city of this Address.

Returns:

the city.

getCountry

java.lang.String getCountry()

Gets the country of this Address.

Returns:

the country.

getFaxNumber

java.lang.String getFaxNumber()

Gets the fax number associated with this Address.

Returns:

the fax number.

getFirstName

java.lang.String getFirstName()

Gets the first name associated with this Address.

Returns:

the first name

getGuid

java.lang.String getGuid()

Return the guid.

Returns:

the guid.

getLastName

java.lang.String getLastName()

Gets the last name associated with this Address.

Returns:

the last name

getPhoneNumber

java.lang.String getPhoneNumber()

Gets the phone number associated with this Address.

Returns:

the phone number.

getRegionPathStr

java.lang.String getRegionPathStr()

Return the string reprents the address's region path info, starting from city. An example will be "Vancouver BC CA".

Returns:

the string reprents the address's region path info

getStreet1

java.lang.String getStreet1()

Gets the streetname of this Address.

Returns:

the streetname.

getStreet2

java.lang.String getStreet2()

Gets the streetname of this Address.

Returns:

the streetname.

getSubCountry

java.lang.String getSubCountry()

Gets the state, province, or other region of the country for this Address.

Returns:

the state, province, or other region of the country

getZipOrPostalCode

java.lang.String getZipOrPostalCode()

Gets the zip/postal code of this Address.

Returns:

the zip/postal code.

isCommercialAddress

boolean isCommercialAddress()

True if this Address is a commercial address.

Returns:

true if the address is commercial.

setCity

void setCity(java.lang.String city)

Sets the city of this Address.

Parameters:

city - the new city.

setCommercialAddress

void setCommercialAddress(boolean commercialAddress)

Sets whether this Address is a commercial address.

Parameters:

commercialAddress - Set to true for commercial addresses.

setCountry

void setCountry(java.lang.String country)

Sets the country of this Address.

Parameters:

country - the new country.

setFaxNumber

void setFaxNumber(java.lang.String faxNumber)

Sets the fax number associated with this Address.

Parameters:

faxNumber - the new fax number.

setFirstName

void setFirstName(java.lang.String firstName)

Sets the first name associated with this Address.

Parameters:

firstName - the first name.

setGuid

void setGuid(java.lang.String guid)

Set the guid.

Parameters:

guid - the guid to set.

setLastName

void setLastName(java.lang.String lastName)

Sets the last name associated with this Address.

Parameters:

lastName - the last name.

setPhoneNumber

void setPhoneNumber(java.lang.String phoneNumber)

Sets the phone number associated with this Address.

Parameters:

phoneNumber - the new phone number.

setStreet1

void setStreet1(java.lang.String street)

Sets the streetname of this Address.

Parameters:

street - the new streetname.

setStreet2

void setStreet2(java.lang.String street)

Sets the streetname of this Address.

Parameters:

street - the new streetname.

setSubCountry

void setSubCountry(java.lang.String subCountry)

Sets the state, province, or other region of the country for this Address.

Parameters:

subCountry - the new state, province, or other region

setZipOrPostalCode

void setZipOrPostalCode(java.lang.String zipOrPostalCode)

Sets the zip/postal code of this Address.

Parameters:

zipOrPostalCode - the new zip/postal code.