public class Address extends Session
Modifier and Type | Field and Description |
---|---|
static java.lang.String | MARKED_DELETED
A constant for the MARKED_DELETED property.
|
static java.lang.String | MARKED_EDITED
A constant for the MARKED_EDITED property.
|
static java.lang.String | MARKED_EXISTNG
A constant for the MARKED_EXISTING property.
|
static java.lang.String | MARKED_NEW
A constant for the MARKED_NEW property.
|
static java.lang.String | PROP_ADDRESS_ID
A constant for the address id property name.
|
static java.lang.String | PROP_ADDRESS_LINE_1
A constant for the first line address property name.
|
static java.lang.String | PROP_ADDRESS_LINE_2
A constant for the second line address property name.
|
static java.lang.String | PROP_ADDRESS_LINE_3
A constant for the third line address property name.
|
static java.lang.String | PROP_ADDRESS_NICK_NAME
A constant for the address nick name property.
|
static java.lang.String | PROP_COMPANY_DEPARTMENT
A constant for the company department property name.
|
static java.lang.String | PROP_COUNTRY_CODE
A constant for the country code property name.
|
static java.lang.String | PROP_COUNTY_DISTRICT
A constant for the county or district property name.
|
static java.lang.String | PROP_DESCRIPTION
A constant for the description property name.
|
static java.lang.String | PROP_EMAIL_ADDRESS
A constant for the email address property name.
|
static java.lang.String | PROP_FAX_NUMBER
A constant for the telephone property name.
|
static java.lang.String | PROP_MARKING
A constant for the marking property.
|
static java.lang.String | PROP_POSTAL_CODE
A constant for the postal code property name.
|
static java.lang.String | PROP_PRIMARY
A constant for the primary property name.
|
static java.lang.String | PROP_REGION
A constant for the region property name.
|
static java.lang.String | PROP_STATE_PROVINCE_CODE
A constant for the state or province code property name.
|
static java.lang.String | PROP_TAX_JURISDICTION
A constant for the tax jurisdiction property name.
|
static java.lang.String | PROP_TELEPHONE
A constant for the telephone property name.
|
static java.lang.String | PROP_TOWN_CITY
A constant for the town or city property name.
|
static java.lang.String | PROP_TYPE
A constant for the type property name.
|
static java.lang.String | PROP_URI
A constant for the URI property name.
|
static java.lang.String | TYPE_B
A unique property name to store the Billing property.
|
static java.lang.String | TYPE_R
A unique property name to store the Residential property.
|
static java.lang.String | TYPE_S
A unique property name to store the Shipping property.
|
static java.lang.String | TYPE_SB
A unique property name to store the Shipping and Billing property.
|
Constructor and Description |
---|
Address()
The default constructor for Address.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String | getAddressId()
This method is a convenience method for retrieving the current setting of the PROP_ADDRESS_ID property.
|
java.lang.String | getAddressLine(java.lang.String name)
Convenience method to get an address line property
|
java.lang.String | getAddressLine1()
This method is a convenience method for retrieving the current setting of the PROP_ADDRESS_LINE_1 property.
|
java.lang.String | getAddressLine2()
This method is a convenience method for retrieving the current setting of the PROP_ADDRESS_LINE_2 property.
|
java.lang.String | getAddressLine3()
This method is a convenience method for retrieving the current setting of the PROP_ADDRESS_LINE_3 property.
|
java.lang.String | getAddressNickName()
This method is a convenience method for retrieving the current setting of the PROP_ADDRESS_NICK_NAME property.
|
java.lang.String | getCompanyDepartment()
This method is a convenience method for retrieving the current setting of the "companyDepartment" property.
|
java.lang.String | getCountryCode()
This method is a convenience method for retrieving the current setting of the PROP_COUNTRY_CODE property.
|
java.lang.String | getCountryName()
This method is a convenience method for retrieving the country name for the address.
|
java.lang.String | getCountyDistrict()
This method is a convenience method for retrieving the current setting of the PROP_COUNTY_DISTRICT property.
|
java.lang.String | getDescription()
This method is a convenience method for retrieving the current setting of the PROP_DESCRIPTION property.
|
java.lang.String | getEmailAddress()
This method is a convenience method for retrieving the current setting of the PROP_EMAIL_ADDRESS property.
|
java.lang.String | getFaxNumber()
This method is a convenience method for retrieving the current setting of the PROP_FAX_NUMBER property.
|
java.lang.String | getMarking()
This method is a convenience method for retrieving the current setting of the PROP_MARKING property.
|
java.lang.String | getPostalCode()
This method is a convenience method for retrieving the current setting of the PROP_POSTAL_CODE property.
|
java.lang.String | getRegion()
This method is a convenience method for retrieving the current setting of the PROP_REGION property.
|
java.lang.String | getStateProvinceCode()
This method is a convenience method for retrieving the current setting of the PROP_STATE_PROVINCE_CODE property.
|
java.lang.String | getStateProvinceName()
This method is a convenience method for retrieving the state or province name for the address.
|
java.lang.String | getTaxJurisdiction()
This method is a convenience method for retrieving the current setting of the PROP_TAX_JURISDICTION property.
|
java.lang.String | getTelephone()
This method is a convenience method for retrieving the current setting of the PROP_TELEPHONE property.
|
java.lang.String | getTownCity()
This method is a convenience method for retrieving the current setting of the PROP_TOWN_CITY property.
|
java.lang.String | getType()
This method is a convenience method for retrieving the current setting of the PROP_TYPE property.
|
java.lang.String | getUri()
This method is a convenience method for retrieving the current setting of the PROP_URI property.
|
boolean | isPrimary()
This method is a convenience method for retrieving the current setting of the PROP_PRIMARY property.
|
void | setAddressId(java.lang.String addressId)
This method is a convenience method for setting the PROP_ADDRESS_ID property.
|
void | setAddressLine(java.lang.String name, java.lang.Object object)
Convenience method for setting an address line property.
|
void | setAddressLine1(java.lang.String addressLine1)
This method is a convenience method for setting the PROP_ADDRESS_LINE_1 property.
|
void | setAddressLine2(java.lang.String addressLine2)
This method is a convenience method for setting the PROP_ADDRESS_LINE_2 property.
|
void | setAddressLine3(java.lang.String addressLine3)
This method is a convenience method for setting the PROP_ADDRESS_LINE_3 property.
|
void | setAddressNickName(java.lang.String addressNickName)
This method is a convenience method for setting the PROP_ADDRESS_NICK_NAME property.
|
void | setCompanyDepartment(java.lang.String companyDepartment)
This method is a convenience method for setting the PROP_COMPANY_DEPARTMENT property.
|
void | setCountryCode(java.lang.String countryCode)
This method is a convenience method for setting the PROP_COUNTRY_CODE property.
|
void | setCountyDistrict(java.lang.String countyDistrict)
This method is a convenience method for setting the PROP_COUNTY_DISTRICT property.
|
void | setDescription(java.lang.String description)
This method is a convenience method for setting the PROP_DESCRIPTION property.
|
void | setEmailAddress(java.lang.String emailAddress)
This method is a convenience method for setting the PROP_EMAIL_ADDRESS property.
|
void | setFaxNumber(java.lang.String faxNumber)
This method is a convenience method for setting the PROP_FAX_NUMBER property.
|
void | setMarking(java.lang.String marking)
This method is a convenience method for setting the PROP_MARKING property.
|
void | setPostalCode(java.lang.String postalCode)
This method is a convenience method for setting the PROP_POSTAL_CODE property.
|
void | setPrimary(boolean primary)
This method is a convenience method for setting the PROP_PRIMARY property.
|
void | setRegion(java.lang.String region)
This method is a convenience method for setting the PROP_REGION property.
|
void | setStateProvinceCode(java.lang.String stateProvinceCode)
This method is a convenience method for setting the PROP_STATE_PROVINCE_CODE property.
|
void | setTaxJurisdiction(java.lang.String taxJurisdiction)
This method is a convenience method for setting the PROP_TAX_JURISDICTION property.
|
void | setTelephone(java.lang.String telephone)
This method is a convenience method for setting the PROP_TELEPHONE property.
|
void | setTownCity(java.lang.String townCity)
This method is a convenience method for setting the PROP_TOWN_CITY property.
|
void | setType(java.lang.String type)
This method is a convenience method for setting the PROP_TYPE property.
|
void | setUri(java.lang.String uri)
This method is a convenience method for setting the PROP_URI property.
|
java.lang.String | toString()
This method returns the string representation of the formatted Address.
|
public static final java.lang.String TYPE_SB
public static final java.lang.String TYPE_S
public static final java.lang.String TYPE_B
public static final java.lang.String TYPE_R
public static final java.lang.String MARKED_EXISTNG
The value is "MARKED_EXISTING".
This is one of the possible values of the PROP_MARKING property.
public static final java.lang.String MARKED_NEW
The value is "MARKED_NEW".
This is one of the possible values of the PROP_MARKING property.
public static final java.lang.String MARKED_EDITED
The value is "MARKED_EDITED".
This is one of the possible values of the PROP_MARKING property.
public static final java.lang.String MARKED_DELETED
The value is "MARKED_DELETED".
This is one of the possible values of the PROP_MARKING property.
public static final java.lang.String PROP_MARKING
The value is "marking".
The data stored under the PROP_MARKING property is a String that is set to one of the following values:
public static final java.lang.String PROP_ADDRESS_ID
The value is "addressId".
The data stored under the PROP_ADDRESS_ID property is a String that contains the address's primary id.
public static final java.lang.String PROP_ADDRESS_NICK_NAME
The value is "addressNickName".
The data stored under the PROP_ADDRESS_NICK_NAME property is a String that contains the address's nick name.
public static final java.lang.String PROP_ADDRESS_LINE_1
The value is "addressLine1".
The data stored under the PROP_ADDRESS_LINE_1 property is a String that contains the first line of the address.
public static final java.lang.String PROP_ADDRESS_LINE_2
The value is "addressLine2".
The data stored under the PROP_ADDRESS_LINE_2 property is a String that contains the second line of the address.
public static final java.lang.String PROP_ADDRESS_LINE_3
The value is "addressLine3".
The data stored under the PROP_ADDRESS_LINE_3 property is a String that contains the third line of the address.
public static final java.lang.String PROP_COMPANY_DEPARTMENT
The value is "companyDepartment".
The data stored under the PROP_COMPANY_DEPARTMENT property is a String that contains the company department.
public static final java.lang.String PROP_TOWN_CITY
The value is "townCity".
The data stored under the PROP_TOWN_CITY property is a String that contains the town or city.
public static final java.lang.String PROP_COUNTY_DISTRICT
The value is "countyDistrict".
The data stored under the PROP_COUNTY_DISTRICT property is a String that contains the county or district.
public static final java.lang.String PROP_STATE_PROVINCE_CODE
The value is "stateProvinceCode".
The data stored under the PROP_STATE_PROVINCE_CODE property is a String that contains the state or province code.
public static final java.lang.String PROP_COUNTRY_CODE
The value is "countryCode".
The data stored under the PROP_COUNTRY_CODE property is a String that contains the country code.
public static final java.lang.String PROP_POSTAL_CODE
The value is "postalCode".
The data stored under the PROP_POSTAL_CODE property is a String that contains the postal code.
public static final java.lang.String PROP_REGION
The value is "region".
The data stored under the PROP_REGION property is a String that contains the region.
public static final java.lang.String PROP_EMAIL_ADDRESS
The value is "emailAddress".
The data stored under the PROP_EMAIL_ADDRESS property is a String that contains the email address.
public static final java.lang.String PROP_TELEPHONE
The value is "telephone".
The data stored under the PROP_TELEPHONE property is a String that contains the telephone number.
public static final java.lang.String PROP_FAX_NUMBER
The value is "faxNumber".
The data stored under the PROP_FAX_NUMBER property is a String that contains the fax number.
public static final java.lang.String PROP_TAX_JURISDICTION
The value is "taxJurisdiction".
The data stored under the PROP_TAX_JURISDICTION property is a String that contains the tax jurisdiction.
public static final java.lang.String PROP_PRIMARY
The value is "primary".
The data stored under the PROP_PRIMARY property is a Boolean that indicates if this is a primary.
public static final java.lang.String PROP_TYPE
The value is "type".
The data stored under the PROP_TYPE property is a String that contains the address type. Possible values are:
public static final java.lang.String PROP_DESCRIPTION
The value is "description".
The data stored under the PROP_DESCRIPTION property is a String that contains the description.
public static final java.lang.String PROP_URI
The value is "uri".
The data stored under the PROP_URI property is a String that contains the URI.
public java.lang.String getAddressId()
public java.lang.String getAddressLine1()
public java.lang.String getAddressLine2()
public java.lang.String getAddressLine3()
public java.lang.String getCountryName()
public java.lang.String getCountryCode()
public java.lang.String getCountyDistrict()
public java.lang.String getPostalCode()
public java.lang.String getRegion()
public java.lang.String getStateProvinceName()
public java.lang.String getStateProvinceCode()
public java.lang.String getTownCity()
public void setAddressId(java.lang.String addressId)
public void setAddressLine1(java.lang.String addressLine1)
public void setAddressLine2(java.lang.String addressLine2)
public void setAddressLine3(java.lang.String addressLine3)
public void setCountryCode(java.lang.String countryCode)
public void setCountyDistrict(java.lang.String countyDistrict)
public void setPostalCode(java.lang.String postalCode)
public void setRegion(java.lang.String region)
public void setStateProvinceCode(java.lang.String stateProvinceCode)
public void setTownCity(java.lang.String townCity)
public java.lang.String getAddressNickName()
public void setAddressNickName(java.lang.String addressNickName)
public java.lang.String toString()
public java.lang.String getDescription()
public java.lang.String getEmailAddress()
public java.lang.String getFaxNumber()
public java.lang.String getTaxJurisdiction()
public java.lang.String getTelephone()
public java.lang.String getUri()
public void setDescription(java.lang.String description)
public void setEmailAddress(java.lang.String emailAddress)
public void setFaxNumber(java.lang.String faxNumber)
public void setTaxJurisdiction(java.lang.String taxJurisdiction)
public void setTelephone(java.lang.String telephone)
public void setUri(java.lang.String uri)
public java.lang.String getType()
public void setType(java.lang.String type)
public boolean isPrimary()
public void setPrimary(boolean primary)
public java.lang.String getCompanyDepartment()
public void setCompanyDepartment(java.lang.String companyDepartment)
public java.lang.String getMarking()
public void setMarking(java.lang.String marking)
public void setAddressLine(java.lang.String name, java.lang.Object object)
public java.lang.String getAddressLine(java.lang.String name)