Class OrderAddress
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.
Property Summary
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
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
Property Details
address1
address1: String
Returns the customer's first address.
address2
address2: String
Returns the customer's second address.
city
city: String
Returns the Customer's City.
companyName
companyName: String
Returns the Customer's company name.
countryCode
countryCode: EnumValue
Returns the customer's country code.
firstName
firstName: String
Returns the Customer's first name.
fullName
fullName: String (read-only)
Returns a concatenation of the Customer's first, middle,
and last names and it' suffix.
jobTitle
jobTitle: String
Returns the customer's job title.
lastName
lastName: String
Returns the customer's last name.
phone
phone: String
Returns the customer's phone number.
postBox
postBox: String
Returns the customer's post box.
postalCode
postalCode: String
Returns the customer's postal code.
salutation
salutation: String
Returns the customer's salutation.
secondName
secondName: String
Returns the customer's second name.
stateCode
stateCode: String
Returns the customer's state.
suffix
suffix: String
Returns the customer's suffix.
suite
suite: String
Returns the customer's suite.
title
title: String
Returns the customer's title.
Method Details
getAddress1()
getAddress1(): String
Returns the customer's first address.
Returns:
getAddress2()
getAddress2(): String
Returns the customer's second address.
Returns:
the second address value.
getCity()
getCity(): String
Returns the Customer's City.
Returns:
getCompanyName()
getCompanyName(): String
Returns the Customer's company name.
Returns:
getCountryCode()
getCountryCode(): EnumValue
Returns the customer's country code.
Returns:
getFirstName()
getFirstName(): String
Returns the Customer's first name.
Returns:
getFullName()
getFullName(): String
Returns a concatenation of the Customer's first, middle,
and last names and it' suffix.
Returns:
a concatenation of the Customer's first, middle,
and last names and it' suffix.
getJobTitle()
getJobTitle(): String
Returns the customer's job title.
Returns:
getLastName()
getLastName(): String
Returns the customer's last name.
Returns:
getPhone()
getPhone(): String
Returns the customer's phone number.
Returns:
getPostBox()
getPostBox(): String
Returns the customer's post box.
Returns:
getPostalCode()
getPostalCode(): String
Returns the customer's postal code.
Returns:
getSalutation()
getSalutation(): String
Returns the customer's salutation.
Returns:
the customer's salutation.
getSecondName()
getSecondName(): String
Returns the customer's second name.
Returns:
getStateCode()
getStateCode(): String
Returns the customer's state.
Returns:
getSuffix()
getSuffix(): String
Returns the customer's suffix.
Returns:
getSuite()
getSuite(): String
Returns the customer's suite.
Returns:
getTitle()
getTitle(): String
Returns the customer's title.
Returns:
isEquivalentAddress(Object)
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(String)
setAddress1(value: String ): void
Sets the customer's first address.
Parameters:
value - The value to set.
setAddress2(String)
setAddress2(value: String ): void
Sets the customer's second address.
Parameters:
value - The value to set.
setCity(String)
setCity(city: String ): void
Sets the Customer's City.
Parameters:
city - the Customer's city to set.
setCompanyName(String)
setCompanyName(companyName: String ): void
Sets the Customer's company name.
Parameters:
companyName - the name of the company.
setCountryCode(String)
setCountryCode(countryCode: String ): void
Sets the Customer's country code.
Parameters:
countryCode - the country code.
setFirstName(String)
setFirstName(firstName: String ): void
Sets the Customer's first name.
Parameters:
firstName - the customer's first name to set.
setJobTitle(String)
setJobTitle(jobTitle: String ): void
Sets the customer's job title.
Parameters:
jobTitle - The job title to set.
setLastName(String)
setLastName(lastName: String ): void
Sets the customer's last name.
Parameters:
lastName - The last name to set.
setPhone(String)
setPhone(phoneNumber: String ): void
Sets the customer's phone number. The length is restricted to 256 characters.
Parameters:
phoneNumber - The phone number to set.
setPostBox(String)
setPostBox(postBox: String ): void
Sets the customer's post box.
Parameters:
postBox - The post box to set.
setPostalCode(String)
setPostalCode(postalCode: String ): void
Sets the customer's postal code.
Parameters:
postalCode - The postal code to set.
setSaluation(String)
setSaluation(value: String ): voidSets the customer's salutation.
Parameters:
value - the customer's salutation.
Deprecated:
Use setSalutation(String)
setSalutation(String)
setSalutation(value: String ): void
Sets the customer's salutation.
Parameters:
value - the customer's salutation.
setSecondName(String)
setSecondName(secondName: String ): void
Sets the customer's second name.
Parameters:
secondName - The second name to set.
setStateCode(String)
setStateCode(state: String ): void
Sets the customer's state.
Parameters:
state - The state to set.
setSuffix(String)
setSuffix(suffix: String ): void
Sets the customer's suffix.
Parameters:
suffix - The suffix to set.
setSuite(String)
setSuite(value: String ): void
Sets the customer's suite. The length is restricted to 256 characters.
Parameters:
value - the customer's suite.
setTitle(String)
setTitle(title: String ): void
Sets the customer's title.
Parameters:
title - The title to set.
j