com.konakart.appif

Interface AddressIf

All Known Implementing Classes:

Address

public interface AddressIf

Used to contain the address of a customer.

Method Summary

Modifier and Type	Method and Description
int	getAddressFormatId()
java.lang.String	getAddressFormatTemplate() An example template is $firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'.
java.lang.String	getAddressSummaryTemplate() An example summary template is $city / $country'.
java.lang.String	getCity()
java.lang.String	getCompany()
int	getCountryId()
java.lang.String	getCountryName()
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
int	getCustomerId()
java.lang.String	getEmailAddr()
java.lang.String	getFirstName()
java.lang.String	getFormattedAddress() It is formatted based on the address format template.
java.lang.String	getFormattedName() The name formatted by the nameFormatTemplate
java.lang.String	getGender() Normally set to "m" or "f".
int	getId()
boolean	getIsPrimary()
java.lang.String	getLastName()
java.lang.String	getNameFormatTemplate() A template to format the name e.g.
java.lang.String	getPostcode()
java.lang.String	getState()
java.lang.String	getStreetAddress()
java.lang.String	getStreetAddress1()
java.lang.String	getSuburb()
java.lang.String	getSummaryAddress() It is formatted based on the address summary format template.
java.lang.String	getTelephoneNumber()
java.lang.String	getTelephoneNumber1()
int	getVendorId()
int	getZoneId()
boolean	isUseZoneId() Used when editing and inserting an address.
void	setAddressFormatId(int addressFormatId)
void	setAddressFormatTemplate(java.lang.String addressFormatTemplate) An example template is $firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'.
void	setAddressSummaryTemplate(java.lang.String addressSummaryTemplate) An example summary template is $city / $country'.
void	setCity(java.lang.String city)
void	setCompany(java.lang.String company)
void	setCountryId(int countryId)
void	setCountryName(java.lang.String countryName)
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setCustomerId(int customerId)
void	setEmailAddr(java.lang.String emailAddr)
void	setFirstName(java.lang.String firstName)
void	setFormattedAddress(java.lang.String formattedAddress) It is formatted based on the address format template.
void	setFormattedName(java.lang.String formattedName) The name formatted by the nameFormatTemplate
void	setGender(java.lang.String gender) Normally set to "m" or "f".
void	setId(int id)
void	setIsPrimary(boolean isPrimary)
void	setLastName(java.lang.String lastName)
void	setNameFormatTemplate(java.lang.String nameFormatTemplate) A template to format the name e.g.
void	setPostcode(java.lang.String postcode)
void	setState(java.lang.String state)
void	setStreetAddress(java.lang.String streetAddress)
void	setStreetAddress1(java.lang.String streetAddress1)
void	setSuburb(java.lang.String suburb)
void	setSummaryAddress(java.lang.String summaryAddress) It is formatted based on the address summary format template.
void	setTelephoneNumber(java.lang.String telephoneNumber)
void	setTelephoneNumber1(java.lang.String telephoneNumber1)
void	setUseZoneId(boolean useZoneId) Used when editing and inserting an address.
void	setVendorId(int vendorId)
void	setZoneId(int zoneId)

Method Detail

getCity

java.lang.String getCity()

Returns:

Returns the city.

setCity

void setCity(java.lang.String city)

Parameters:

city - The city to set.

getCompany

java.lang.String getCompany()

Returns:

Returns the company.

setCompany

void setCompany(java.lang.String company)

Parameters:

company - The company to set.

getCountryId

int getCountryId()

Returns:

Returns the country.

setCountryId

void setCountryId(int countryId)

Parameters:

countryId - The country to set.

getCustomerId

int getCustomerId()

Returns:

Returns the customerId.

setCustomerId

void setCustomerId(int customerId)

Parameters:

customerId - The customerId to set.

getVendorId

int getVendorId()

Returns:

the vendorId

setVendorId

void setVendorId(int vendorId)

Parameters:

vendorId - the vendorId to set

getFirstName

java.lang.String getFirstName()

Returns:

Returns the firstName.

setFirstName

void setFirstName(java.lang.String firstName)

Parameters:

firstName - The firstName to set.

getGender

java.lang.String getGender()

Normally set to "m" or "f". (Can be set to "x" if Other genders are enabled)

Returns:

Returns the gender.

setGender

void setGender(java.lang.String gender)

Normally set to "m" or "f". (Can be set to "x" if Other genders are enabled)

Parameters:

gender - The gender to set.

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getLastName

java.lang.String getLastName()

Returns:

Returns the lastName.

setLastName

void setLastName(java.lang.String lastName)

Parameters:

lastName - The lastName to set.

getPostcode

java.lang.String getPostcode()

Returns:

Returns the postcode.

setPostcode

void setPostcode(java.lang.String postcode)

Parameters:

postcode - The postcode to set.

getState

java.lang.String getState()

Returns:

Returns the state.

setState

void setState(java.lang.String state)

Parameters:

state - The state to set.

getStreetAddress

java.lang.String getStreetAddress()

Returns:

Returns the streetAddress.

setStreetAddress

void setStreetAddress(java.lang.String streetAddress)

Parameters:

streetAddress - The streetAddress to set.

getStreetAddress1

java.lang.String getStreetAddress1()

Returns:

the streetAddress1

setStreetAddress1

void setStreetAddress1(java.lang.String streetAddress1)

Parameters:

streetAddress1 - the streetAddress1 to set

getSuburb

java.lang.String getSuburb()

Returns:

Returns the suburb.

setSuburb

void setSuburb(java.lang.String suburb)

Parameters:

suburb - The suburb to set.

getZoneId

int getZoneId()

Returns:

Returns the zoneId.

setZoneId

void setZoneId(int zoneId)

Parameters:

zoneId - The zoneId to set.

isUseZoneId

boolean isUseZoneId()

Used when editing and inserting an address. If set to true, then the zoneId is used rather than looking up the zone.

Returns:

the useZoneId

setUseZoneId

void setUseZoneId(boolean useZoneId)

Used when editing and inserting an address. If set to true, then the zoneId is used rather than looking up the zone.

Parameters:

useZoneId - the useZoneId to set

getAddressFormatTemplate

java.lang.String getAddressFormatTemplate()

An example template is $firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'.

Returns:

Returns the addressFormatTemplate.

setAddressFormatTemplate

void setAddressFormatTemplate(java.lang.String addressFormatTemplate)

An example template is $firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'.

Parameters:

addressFormatTemplate - The addressFormatTemplate to set.

getAddressSummaryTemplate

java.lang.String getAddressSummaryTemplate()

An example summary template is $city / $country'.

Returns:

Returns the addressSummaryTemplate.

setAddressSummaryTemplate

void setAddressSummaryTemplate(java.lang.String addressSummaryTemplate)

An example summary template is $city / $country'.

Parameters:

addressSummaryTemplate - The addressSummaryTemplate to set.

getFormattedAddress

java.lang.String getFormattedAddress()

It is formatted based on the address format template.

Returns:

Returns the formattedAddress.

setFormattedAddress

void setFormattedAddress(java.lang.String formattedAddress)

It is formatted based on the address format template.

Parameters:

formattedAddress - The formattedAddress to set.

getSummaryAddress

java.lang.String getSummaryAddress()

It is formatted based on the address summary format template.

Returns:

Returns the summaryAddress.

setSummaryAddress

void setSummaryAddress(java.lang.String summaryAddress)

It is formatted based on the address summary format template.

Parameters:

summaryAddress - The summaryAddress to set.

getNameFormatTemplate

java.lang.String getNameFormatTemplate()

A template to format the name e.g. $firstname $lastname

Returns:

the nameFormatTemplate

setNameFormatTemplate

void setNameFormatTemplate(java.lang.String nameFormatTemplate)

A template to format the name e.g. $firstname $lastname

Parameters:

nameFormatTemplate - the nameFormatTemplate to set

getFormattedName

java.lang.String getFormattedName()

The name formatted by the nameFormatTemplate

Returns:

the formattedName

setFormattedName

void setFormattedName(java.lang.String formattedName)

The name formatted by the nameFormatTemplate

Parameters:

formattedName - the formattedName to set

getCountryName

java.lang.String getCountryName()

Returns:

Returns the countryName.

setCountryName

void setCountryName(java.lang.String countryName)

Parameters:

countryName - The countryName to set.

getTelephoneNumber

java.lang.String getTelephoneNumber()

Returns:

the telephoneNumber

setTelephoneNumber

void setTelephoneNumber(java.lang.String telephoneNumber)

Parameters:

telephoneNumber - the telephoneNumber to set

getTelephoneNumber1

java.lang.String getTelephoneNumber1()

Returns:

the telephoneNumber1

setTelephoneNumber1

void setTelephoneNumber1(java.lang.String telephoneNumber1)

Parameters:

telephoneNumber1 - the telephoneNumber1 to set

getEmailAddr

java.lang.String getEmailAddr()

Returns:

the emailAddr

setEmailAddr

void setEmailAddr(java.lang.String emailAddr)

Parameters:

emailAddr - the emailAddr to set

getIsPrimary

boolean getIsPrimary()

Returns:

Returns the isPrimary.

setIsPrimary

void setIsPrimary(boolean isPrimary)

Parameters:

isPrimary - The isPrimary to set.

getAddressFormatId

int getAddressFormatId()

Returns:

Returns the addressFormatId.

setAddressFormatId

void setAddressFormatId(int addressFormatId)

Parameters:

addressFormatId - The addressFormatId to set.

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.