Class CustomerAddress

• Object
  • dw.object.PersistentObject
    • dw.object.ExtensibleObject
      • dw.customer.CustomerAddress

The Address class represents a customer's address.

Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements.

Properties

address1 : String

The customer's first address.

address2 : String

The customer's second address value.

city : String

The customer's city.

companyName : String

The customer's company name.

countryCode : EnumValue

The customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.

firstName : String

The customer's first name.

fullName : String Read Only

A concatenation of the customer's first, middle, and last names and its suffix.

ID : String

The name of the address.

jobTitle : String

The customer's job title.

lastName : String

The customer's last name.

phone : String

The customer's phone number.

postalCode : String

The customer's postal code.

postBox : String

The customer's post box.

salutation : String

The customer's salutation.

secondName : String

The customer's second name.

stateCode : String

The customer's state.

suffix : String

The customer's suffix.

suite : String

The customer's suite.

title : String

The customer's title.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getAddress1() : String

Returns the customer's first address.

getAddress2() : String

Returns the customer's second address value.

getCity() : String

Returns the customer's city.

getCompanyName() : String

Returns the customer's company name.

getCountryCode() : EnumValue

Returns the customer's country code.

getFirstName() : String

Returns the customer's first name.

getFullName() : String

Returns a concatenation of the customer's first, middle, and last names and its suffix.

getID() : String

Returns the name of the address.

getJobTitle() : String

Returns the customer's job title.

getLastName() : String

Returns the customer's last name.

getPhone() : String

Returns the customer's phone number.

getPostalCode() : String

Returns the customer's postal code.

getPostBox() : String

Returns the customer's post box.

getSalutation() : String

Returns the customer's salutation.

getSecondName() : String

Returns the customer's second name.

getStateCode() : String

Returns the customer's state.

getSuffix() : String

Returns the customer's suffix.

getSuite() : String

Returns the customer's suite.

getTitle() : String

Returns the customer's title.

isEquivalentAddress(address : Object) : boolean

Returns true if the specified address is equivalent to this address.

setAddress1(value : String) : void

Sets the value of the customer's first address.

setAddress2(value : String) : void

Sets the customer's second address value.

setCity(city : String) : void

Sets the customer's city.

setCompanyName(companyName : String) : void

Sets the customer's company name.

setCountryCode(countryCode : String) : void

Sets the customer's country code.

setFirstName(firstName : String) : void

Sets the customer's first name.

setID(value : String) : void

Sets the address name.

setJobTitle(jobTitle : String) : void

Sets the customer's job title.

setLastName(lastName : String) : void

Sets the customer's last name.

setPhone(phoneNumber : String) : void

Sets the customer's phone number.

setPostalCode(postalCode : String) : void

Sets the customer's postal code.

setPostBox(postBox : String) : void

Sets the customer's post box.

setSaluation(value : String) : void

Sets the customer's salutation.

setSalutation(value : String) : void

Sets the customer's salutation.

setSecondName(secondName : String) : void

Sets the customer's second name.

setStateCode(state : String) : void

Sets the customer's state.

setSuffix(suffix : String) : void

Sets the customer's suffix.

setSuite(value : String) : void

Sets the customer's suite.

setTitle(title : String) : void

Sets the customer's title.

Methods inherited from class ExtensibleObject

describe, getCustom

Methods inherited from class PersistentObject

getCreationDate, getLastModified, getUUID

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getAddress1

getAddress1() : String

Returns the customer's first address.

Returns:

the first address value.

getAddress2

getAddress2() : String

Returns the customer's second address value.

Returns:

the value of the second address.

getCity

getCity() : String

Returns the customer's city.

Returns:

the customer's city.

getCompanyName

getCompanyName() : String

Returns the customer's company name.

Returns:

the company name.

getCountryCode

getCountryCode() : EnumValue

Returns the customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.

Returns:

the two-digit country code.

getFirstName

getFirstName() : String

Returns the customer's first name.

Returns:

the customer first name.

getFullName

getFullName() : String

Returns a concatenation of the customer's first, middle, and last names and its suffix.

Returns:

a concatenation of the customer's first, middle, and last names and its suffix.

getID

getID() : String

Returns the name of the address.

Returns:

the address name.

getJobTitle

getJobTitle() : String

Returns the customer's job title.

Returns:

the job title.

getLastName

getLastName() : String

Returns the customer's last name.

Returns:

the last name.

getPhone

getPhone() : String

Returns the customer's phone number.

Returns:

the phone number.

getPostalCode

getPostalCode() : String

Returns the customer's postal code.

Returns:

the postal code.

getPostBox

getPostBox() : String

Returns the customer's post box.

Returns:

the post box.

getSalutation

getSalutation() : String

Returns the customer's salutation.

Returns:

the salutation.

getSecondName

getSecondName() : String

Returns the customer's second name.

Returns:

the second name.

getStateCode

getStateCode() : String

Returns the customer's state.

Returns:

the state.

getSuffix

getSuffix() : String

Returns the customer's suffix.

Returns:

the suffix.

getSuite

getSuite() : String

Returns the customer's suite.

Returns:

the suite.

getTitle

getTitle() : String

Returns the customer's title.

Returns:

the title.

isEquivalentAddress

isEquivalentAddress(address : Object) : boolean

Returns true if the specified address is equivalent to this address. An equivalent address is an address whose core attributes contain the same values. The core attributes are:

• address1
• address2
• city
• companyName
• countryCode
• firstName
• lastName
• postalCode
• postBox
• stateCode

Parameters:

address - the address to test.

Returns:

true if the specified address is equivalent to this address, false otherwise.

setAddress1

setAddress1(value : String) : void

Sets the value of the customer's first address.

Parameters:

value - The value to set.

setAddress2

setAddress2(value : String) : void

Sets the customer's second address value.

Parameters:

value - The value to set.

setCity

setCity(city : String) : void

Sets the customer's city.

Parameters:

city - the customer's city to set.

setCompanyName

setCompanyName(companyName : String) : void

Sets the customer's company name.

Parameters:

companyName - the name of the company.

setCountryCode

setCountryCode(countryCode : String) : void

Sets the customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.

Parameters:

countryCode - the country code, must be no more than 2 characters or will be truncated.

setFirstName

setFirstName(firstName : String) : void

Sets the customer's first name.

Parameters:

firstName - the customer's first name to set.

setID

setID(value : String) : void

Sets the address name.

Parameters:

value - the name to use.

setJobTitle

setJobTitle(jobTitle : String) : void

Sets the customer's job title.

Parameters:

jobTitle - The jobTitle to set.

setLastName

setLastName(lastName : String) : void

Sets the customer's last name.

Parameters:

lastName - The last name to set.

setPhone

setPhone(phoneNumber : String) : void

Sets the customer's phone number. The length is restricted to 32 characters.

Parameters:

phoneNumber - The phone number to set.

setPostalCode

setPostalCode(postalCode : String) : void

Sets the customer's postal code.

Parameters:

postalCode - The postal code to set.

setPostBox

setPostBox(postBox : String) : void

Sets the customer's post box.

Parameters:

postBox - The post box to set.

setSaluation

setSaluation(value : String) : void

Sets the customer's salutation.

Deprecated:

Use setSalutation(String)

Parameters:

value - the salutation.

setSalutation

setSalutation(value : String) : void

Sets the customer's salutation.

Parameters:

value - the salutation.

setSecondName

setSecondName(secondName : String) : void

Sets the customer's second name.

Parameters:

secondName - The second name to set.

setStateCode

setStateCode(state : String) : void

Sets the customer's state.

Parameters:

state - The state to set.

setSuffix

setSuffix(suffix : String) : void

Sets the customer's suffix.

Parameters:

suffix - The suffix to set.

setSuite

setSuite(value : String) : void

Sets the customer's suite. The length is restricted to 32 characters.

Parameters:

value - the suite to set.

setTitle

setTitle(title : String) : void

Sets the customer's title.

Parameters:

title - The title to set.