AdminAddress (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminAddress

public class AdminAddress
extends java.lang.Object

Address object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`addressFormatTemplate` addressFormatTemplate.
`private java.lang.String`	`addressSummaryTemplate` addressSummaryTemplate.
`private java.lang.String`	`addrStoreId` addrStoreId
`private java.lang.String`	`city` city
`private java.lang.String`	`company` company
`private java.lang.String`	`countryCatKey` The countryCatKey field - not in the d/b
`private int`	`countryId` countryId
`private java.lang.String`	`countryName` countryName
`private java.lang.String`	`custom1` custom field
`private java.lang.String`	`custom2` custom field
`private java.lang.String`	`custom3` custom field
`private java.lang.String`	`custom4` custom field
`private java.lang.String`	`custom5` custom field
`private int`	`customerId` customerId
`private int`	`defaultAddrId` Default address id from Customer table
`private java.lang.String`	`emailAddr` emailAddr
`private java.lang.String`	`firstName` firstName
`private java.lang.String`	`formattedAddress` formattedAddress.
`private java.lang.String`	`formattedName` formattedName.
`private java.lang.String`	`gender` gender
`private int`	`id` id
`private boolean`	`isPrimary` True if this is the primary address.
`private java.lang.String`	`lastName` lastName
`private int`	`manufacturerId` manufacturerId
`private java.lang.String`	`nameFormatTemplate` nameFormatTemplate.
`private java.lang.String`	`postcode` postcode
`private java.lang.String`	`state` state
`private java.lang.String`	`streetAddress` streetAddress
`private java.lang.String`	`streetAddress1` streetAddress1
`private java.lang.String`	`suburb` suburb
`private java.lang.String`	`summaryAddress` summaryAddress.
`private java.lang.String`	`telephoneNumber` telephoneNumber
`private java.lang.String`	`telephoneNumber1` telephoneNumber1
`private int`	`vendorId` vendorId
`private int`	`zoneId` zoneId

Constructor Summary

Constructors
Constructor and Description
`AdminAddress()` Constructor
`AdminAddress(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)` Instantiates the attributes of the Address object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createFormattedAddresses()` Based on the address templates, the formatted addresses are created.
`java.lang.String`	`getAddressFormatTemplate()`
`java.lang.String`	`getAddressSummaryTemplate()`
`java.lang.String`	`getAddrStoreId()`
`java.lang.String`	`getCity()`
`java.lang.String`	`getCompany()`
`java.lang.String`	`getCountryCatKey()`
`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()`
`int`	`getDefaultAddrId()`
`java.lang.String`	`getEmailAddr()`
`java.lang.String`	`getFirstName()`
`java.lang.String`	`getFormattedAddress()`
`java.lang.String`	`getFormattedName()`
`java.lang.String`	`getGender()`
`int`	`getId()`
`boolean`	`getIsPrimary()`
`java.lang.String`	`getLastName()`
`int`	`getManufacturerId()`
`java.lang.String`	`getNameFormatTemplate()`
`java.lang.String`	`getPostcode()`
`java.lang.String`	`getState()`
`java.lang.String`	`getStreetAddress()`
`java.lang.String`	`getStreetAddress1()`
`java.lang.String`	`getSuburb()`
`java.lang.String`	`getSummaryAddress()`
`java.lang.String`	`getTelephoneNumber()`
`java.lang.String`	`getTelephoneNumber1()`
`int`	`getVendorId()`
`int`	`getZoneId()`
`void`	`setAddressFormatTemplate(java.lang.String addressFormatTemplate)`
`void`	`setAddressSummaryTemplate(java.lang.String addressSummaryTemplate)`
`void`	`setAddrStoreId(java.lang.String addrStoreId)`
`void`	`setCity(java.lang.String city)`
`void`	`setCompany(java.lang.String company)`
`void`	`setCountryCatKey(java.lang.String countryCatKey)`
`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`	`setDefaultAddrId(int defaultAddrId)`
`void`	`setEmailAddr(java.lang.String emailAddr)`
`void`	`setFirstName(java.lang.String firstName)`
`void`	`setFormattedAddress(java.lang.String formattedAddress)`
`void`	`setFormattedName(java.lang.String formattedName)`
`void`	`setGender(java.lang.String gender)`
`void`	`setId(int id)`
`void`	`setIsPrimary(boolean isPrimary)`
`void`	`setLastName(java.lang.String lastName)`
`void`	`setManufacturerId(int manufacturerId)`
`void`	`setNameFormatTemplate(java.lang.String nameFormatTemplate)`
`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)`
`void`	`setTelephoneNumber(java.lang.String telephoneNumber)`
`void`	`setTelephoneNumber1(java.lang.String telephoneNumber1)`
`void`	`setVendorId(int vendorId)`
`void`	`setZoneId(int zoneId)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
private int id
```
    id
  - customerId
```
private int customerId
```
    customerId
  - vendorId
```
private int vendorId
```
    vendorId
  - manufacturerId
```
private int manufacturerId
```
    manufacturerId
  - addrStoreId
```
private java.lang.String addrStoreId
```
    addrStoreId
  - gender
```
private java.lang.String gender
```
    gender
  - company
```
private java.lang.String company
```
    company
  - firstName
```
private java.lang.String firstName
```
    firstName
  - lastName
```
private java.lang.String lastName
```
    lastName
  - streetAddress
```
private java.lang.String streetAddress
```
    streetAddress
  - streetAddress1
```
private java.lang.String streetAddress1
```
    streetAddress1
  - suburb
```
private java.lang.String suburb
```
    suburb
  - postcode
```
private java.lang.String postcode
```
    postcode
  - city
```
private java.lang.String city
```
    city
  - state
```
private java.lang.String state
```
    state
  - countryId
```
private int countryId
```
    countryId
  - countryName
```
private java.lang.String countryName
```
    countryName
  - countryCatKey
```
private java.lang.String countryCatKey
```
    The countryCatKey field - not in the d/b
  - telephoneNumber
```
private java.lang.String telephoneNumber
```
    telephoneNumber
  - telephoneNumber1
```
private java.lang.String telephoneNumber1
```
    telephoneNumber1
  - emailAddr
```
private java.lang.String emailAddr
```
    emailAddr
  - zoneId
```
private int zoneId
```
    zoneId
  - addressFormatTemplate
```
private java.lang.String addressFormatTemplate
```
    addressFormatTemplate. Template used to format the address.
  - formattedAddress
```
private java.lang.String formattedAddress
```
    formattedAddress. Address formatted using the addressFormatTemplate.
  - addressSummaryTemplate
```
private java.lang.String addressSummaryTemplate
```
    addressSummaryTemplate. Template used to format the address.
  - summaryAddress
```
private java.lang.String summaryAddress
```
    summaryAddress. Address formatted using the addressSummaryTemplate.
  - nameFormatTemplate
```
private java.lang.String nameFormatTemplate
```
    nameFormatTemplate. Template used to format the person's name.
  - formattedName
```
private java.lang.String formattedName
```
    formattedName. Name formatted using the nameFormatTemplate.
  - isPrimary
```
private boolean isPrimary
```
    True if this is the primary address. False otherwise
  - defaultAddrId
```
private int defaultAddrId
```
    Default address id from Customer table
  - custom1
```
private java.lang.String custom1
```
    custom field
  - custom2
```
private java.lang.String custom2
```
    custom field
  - custom3
```
private java.lang.String custom3
```
    custom field
  - custom4
```
private java.lang.String custom4
```
    custom field
  - custom5
```
private java.lang.String custom5
```
    custom field
- Constructor Detail
  - AdminAddress
```
public AdminAddress()
```
    Constructor
  - AdminAddress
```
public AdminAddress(com.workingdogs.village.Record vr,
                    com.konakart.db.KKCriteria c)
             throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the Address object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Address object.
  - createFormattedAddresses
```
public void createFormattedAddresses()
```
    Based on the address templates, the formatted addresses are created.
    An example template is :
    $firstname $lastname$cr$company$cr$streets$cr$city, $postcode$cr$state, $country$crtel: $telephone $telephone1$cremail: $email
    Valid template attributes are:
    - $cr - Carriage return (new line)
    - $firstname
    - $lastname
    - $streets
    - $street
    - $street1
    - $suburb
    - $city
    - $postcode
    - $state
    - $telephone
    - $telephone1
    - $email
    - $country
    - $custom1
    - $custom2
    - $custom3
    - $custom4
    - $custom5
    Note that streets is customerStreetAddress + line break + customerSuburb .
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing selected attributes of the Address object.
  - getCity
```
public java.lang.String getCity()
```
    Returns:
    
    Returns the city.
  - setCity
```
public void setCity(java.lang.String city)
```
    Parameters:
    
    city - The city to set.
  - getCompany
```
public java.lang.String getCompany()
```
    Returns:
    
    Returns the company.
  - setCompany
```
public void setCompany(java.lang.String company)
```
    Parameters:
    
    company - The company to set.
  - getCountryId
```
public int getCountryId()
```
    Returns:
    
    Returns the country.
  - setCountryId
```
public void setCountryId(int countryId)
```
    Parameters:
    
    countryId - The country to set.
  - getCustomerId
```
public int getCustomerId()
```
    Returns:
    
    Returns the customerId.
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - The customerId to set.
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns:
    
    Returns the firstName.
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Parameters:
    
    firstName - The firstName to set.
  - getGender
```
public java.lang.String getGender()
```
    Returns:
    
    Returns the gender.
  - setGender
```
public void setGender(java.lang.String gender)
```
    Parameters:
    
    gender - The gender to set.
  - getId
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getLastName
```
public java.lang.String getLastName()
```
    Returns:
    
    Returns the lastName.
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Parameters:
    
    lastName - The lastName to set.
  - getPostcode
```
public java.lang.String getPostcode()
```
    Returns:
    
    Returns the postcode.
  - setPostcode
```
public void setPostcode(java.lang.String postcode)
```
    Parameters:
    
    postcode - The postcode to set.
  - getState
```
public java.lang.String getState()
```
    Returns:
    
    Returns the state.
  - setState
```
public void setState(java.lang.String state)
```
    Parameters:
    
    state - The state to set.
  - getStreetAddress
```
public java.lang.String getStreetAddress()
```
    Returns:
    
    Returns the streetAddress.
  - setStreetAddress
```
public void setStreetAddress(java.lang.String streetAddress)
```
    Parameters:
    
    streetAddress - The streetAddress to set.
  - getSuburb
```
public java.lang.String getSuburb()
```
    Returns:
    
    Returns the suburb.
  - setSuburb
```
public void setSuburb(java.lang.String suburb)
```
    Parameters:
    
    suburb - The suburb to set.
  - getZoneId
```
public int getZoneId()
```
    Returns:
    
    Returns the zoneId.
  - setZoneId
```
public void setZoneId(int zoneId)
```
    Parameters:
    
    zoneId - The zoneId to set.
  - getAddressFormatTemplate
```
public java.lang.String getAddressFormatTemplate()
```
    Returns:
    
    Returns the addressFormatTemplate.
  - setAddressFormatTemplate
```
public void setAddressFormatTemplate(java.lang.String addressFormatTemplate)
```
    Parameters:
    
    addressFormatTemplate - The addressFormatTemplate to set.
  - getAddressSummaryTemplate
```
public java.lang.String getAddressSummaryTemplate()
```
    Returns:
    
    Returns the addressSummaryTemplate.
  - setAddressSummaryTemplate
```
public void setAddressSummaryTemplate(java.lang.String addressSummaryTemplate)
```
    Parameters:
    
    addressSummaryTemplate - The addressSummaryTemplate to set.
  - getFormattedAddress
```
public java.lang.String getFormattedAddress()
```
    Returns:
    
    Returns the formattedAddress.
  - setFormattedAddress
```
public void setFormattedAddress(java.lang.String formattedAddress)
```
    Parameters:
    
    formattedAddress - The formattedAddress to set.
  - getSummaryAddress
```
public java.lang.String getSummaryAddress()
```
    Returns:
    
    Returns the summaryAddress.
  - setSummaryAddress
```
public void setSummaryAddress(java.lang.String summaryAddress)
```
    Parameters:
    
    summaryAddress - The summaryAddress to set.
  - getCountryName
```
public java.lang.String getCountryName()
```
    Returns:
    
    Returns the countryName.
  - setCountryName
```
public void setCountryName(java.lang.String countryName)
```
    Parameters:
    
    countryName - The countryName to set.
  - getIsPrimary
```
public boolean getIsPrimary()
```
    Returns:
    
    Returns the isPrimary.
  - setIsPrimary
```
public void setIsPrimary(boolean isPrimary)
```
    Parameters:
    
    isPrimary - The isPrimary to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    Returns the custom1.
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    Returns the custom2.
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    Returns the custom3.
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    Returns the custom4.
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
public java.lang.String getCustom5()
```
    Returns:
    
    Returns the custom5.
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - The custom5 to set.
  - getTelephoneNumber
```
public java.lang.String getTelephoneNumber()
```
    Returns:
    
    the telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(java.lang.String telephoneNumber)
```
    Parameters:
    
    telephoneNumber - the telephoneNumber to set
  - getTelephoneNumber1
```
public java.lang.String getTelephoneNumber1()
```
    Returns:
    
    the telephoneNumber1
  - setTelephoneNumber1
```
public void setTelephoneNumber1(java.lang.String telephoneNumber1)
```
    Parameters:
    
    telephoneNumber1 - the telephoneNumber1 to set
  - getEmailAddr
```
public java.lang.String getEmailAddr()
```
    Returns:
    
    the emailAddr
  - setEmailAddr
```
public void setEmailAddr(java.lang.String emailAddr)
```
    Parameters:
    
    emailAddr - the emailAddr to set
  - getStreetAddress1
```
public java.lang.String getStreetAddress1()
```
    Returns:
    
    the streetAddress1
  - setStreetAddress1
```
public void setStreetAddress1(java.lang.String streetAddress1)
```
    Parameters:
    
    streetAddress1 - the streetAddress1 to set
  - getManufacturerId
```
public int getManufacturerId()
```
    Returns:
    
    the manufacturerId
  - setManufacturerId
```
public void setManufacturerId(int manufacturerId)
```
    Parameters:
    
    manufacturerId - the manufacturerId to set
  - getCountryCatKey
```
public java.lang.String getCountryCatKey()
```
    Returns:
    
    the countryCatKey
  - setCountryCatKey
```
public void setCountryCatKey(java.lang.String countryCatKey)
```
    Parameters:
    
    countryCatKey - the countryCatKey to set
  - getDefaultAddrId
```
public int getDefaultAddrId()
```
    Returns:
    
    the defaultAddrId
  - setDefaultAddrId
```
public void setDefaultAddrId(int defaultAddrId)
```
    Parameters:
    
    defaultAddrId - the defaultAddrId to set
  - getAddrStoreId
```
public java.lang.String getAddrStoreId()
```
    Returns:
    
    the addrStoreId
  - setAddrStoreId
```
public void setAddrStoreId(java.lang.String addrStoreId)
```
    Parameters:
    
    addrStoreId - the addrStoreId to set
  - getFormattedName
```
public java.lang.String getFormattedName()
```
    Returns:
    
    the formattedName
  - setFormattedName
```
public void setFormattedName(java.lang.String formattedName)
```
    Parameters:
    
    formattedName - the formattedName to set
  - getNameFormatTemplate
```
public java.lang.String getNameFormatTemplate()
```
    Returns:
    
    the nameFormatTemplate
  - setNameFormatTemplate
```
public void setNameFormatTemplate(java.lang.String nameFormatTemplate)
```
    Parameters:
    
    nameFormatTemplate - the nameFormatTemplate to set
  - getVendorId
```
public int getVendorId()
```
    Returns:
    
    the vendorId
  - setVendorId
```
public void setVendorId(int vendorId)
```
    Parameters:
    
    vendorId - the vendorId to set

Class AdminAddress

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

customerId

vendorId

manufacturerId

addrStoreId

gender

company

firstName

lastName

streetAddress

streetAddress1

suburb

postcode

city

state

countryId

countryName

countryCatKey

telephoneNumber

telephoneNumber1

emailAddr

zoneId

addressFormatTemplate

formattedAddress

addressSummaryTemplate

summaryAddress

nameFormatTemplate

formattedName

isPrimary

defaultAddrId

custom1

custom2

custom3

custom4

custom5

Constructor Detail

AdminAddress

AdminAddress

Method Detail

toString

createFormattedAddresses

toStringBrief

getCity

setCity

getCompany

setCompany

getCountryId

setCountryId

getCustomerId

setCustomerId

getFirstName

setFirstName

getGender

setGender

getId

setId

getLastName

setLastName

getPostcode

setPostcode

getState

setState

getStreetAddress

setStreetAddress

getSuburb

setSuburb

getZoneId

setZoneId

getAddressFormatTemplate

setAddressFormatTemplate

getAddressSummaryTemplate

setAddressSummaryTemplate

getFormattedAddress

setFormattedAddress