Customer

java.lang.Object
- com.dpslink.base.obj.MappedAttributesObject
- - com.dpslink.base.jdbc.JDBCObject<Customer>
  - - com.dpslink.flash.db.Customer

All Implemented Interfaces:

JDBCObjectKey<Customer>, java.io.Serializable, java.lang.Comparable<Customer>
```
public class Customer
extends JDBCObject<Customer>
```
Defines the fields and methods for customer table objects.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_CUST` A constant that defines the default customer for a retail site.
`static java.lang.String`	`ONETIME_SHIPTO` A constant that defines the customer id for a one-time ship-to.
`private static long`	`serialVersionUID` The class' serialization version id.

Fields inherited from class com.dpslink.base.jdbc.JDBCObject
LOWVAL_RPG_DATE, LOWVAL_RPG_TIME, STATUS_ACTIVE, STATUS_BLANK, STATUS_CANCELED, STATUS_DELETED, STATUS_INACTIVE, STATUS_PENDING

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject
ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors
Constructor and Description

Customer()
Constructs a Customer object with all field values set to null.

Constructors
Constructor and Description
`Customer()` Constructs a `Customer` object with all field values set to `null`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAddress1()` Returns the address line 1.
`java.lang.String`	`getAddress2()` Returns the address line 2.
`java.lang.String`	`getAddress3()` Returns the address line 3.
`java.lang.String`	`getAddress4()` Returns the address line 4.
`java.lang.String`	`getARFax()` Returns the A/R fax number.
`java.lang.String`	`getARPhone()` Returns the A/R phone number.
`java.lang.String`	`getBilltoId()` Returns the bill-to customer id.
`java.lang.String`	`getCity()` Returns the city.
`boolean`	`getCommercial()` Returns the is commerical address flag.
`java.lang.String`	`getContactName()` (not persisted) Returns the contact name.
`java.lang.String`	`getContactPhone()` (not persisted) Returns the contact phone number.
`Country`	`getCountry()` Returns the country object.
`java.lang.String`	`getCountryCode()` Returns the country code.
`java.lang.String`	`getEmailAddr()` Returns the email address.
`java.lang.String`	`getFax()` Returns the fax number.
`java.lang.String`	`getId()` Returns the unique id for the customer.
`boolean`	`getIsPersisted()` (not persisted) Returns the is persisted flag.
`java.lang.String`	`getName()` Returns the name.
`java.lang.String`	`getPhone()` Returns the phone number.
`java.lang.String`	`getPostalCode()` Returns the postal code.
`boolean`	`getPrepay()` Returns the is prepay flag.
`java.lang.String`	`getShipforId()` Returns the ship-for customer id.
`State`	`getState()` Returns the state/province object.
`java.lang.String`	`getStateCode()` Returns the state/province code.
`java.lang.String`	`getStatusCode()` Returns the status code (defined by backend).
`java.lang.String`	`getStatusText()` Returns the status code text (defined by backend).
`java.lang.String`	`getVerificationAddress()` (not persisted) Returns the customer's address used for verifying credit card transactions.
`java.lang.String`	`getVerificationPostalCode()` (not persisted) Returns the customer's postal code used for verifying credit card transactions.
`java.lang.String`	`getXrefCode()` Returns the product cross reference code.
`boolean`	`isDefaultCustomer()` (not persisted) Answers if the customer is the default customer.
`boolean`	`isOneTimeShipto()` (not persisted) Answers if the customer is a one-time ship-to.
`boolean`	`isStatusDelete()` (not persisted) Answers if the customer status is delete.
`void`	`setAddress1(java.lang.String value)` Sets the address line 1.
`void`	`setAddress2(java.lang.String value)` Sets the address line 2.
`void`	`setAddress3(java.lang.String value)` Sets the address line 3.
`void`	`setAddress4(java.lang.String value)` Sets the address line 4.
`void`	`setARFax(java.lang.String value)` Sets the A/R fax number.
`void`	`setARPhone(java.lang.String value)` Sets the A/R phone number.
`void`	`setBilltoId(java.lang.String value)` Sets the bill-to customer id.
`void`	`setCity(java.lang.String value)` Sets the city.
`void`	`setCommercial(boolean value)` Sets the is commerical address flag.
`void`	`setContactName(java.lang.String value)` (not persisted) Sets the contact name.
`void`	`setContactPhone(java.lang.String value)` (not persisted) Sets the contact phone number.
`void`	`setCountry(Country value)` Sets the country object.
`private void`	`setCountryCode(java.lang.String value)` Sets the country code.
`void`	`setEmailAddr(java.lang.String value)` Sets the email address.
`void`	`setFax(java.lang.String value)` Sets the fax number.
`void`	`setId(java.lang.String value)` Sets the unique id for the customer.
`void`	`setIsPersisted(boolean value)` (not persisted) Sets the is persisted flag.
`void`	`setName(java.lang.String value)` Sets the name.
`void`	`setPhone(java.lang.String value)` Sets the phone number.
`void`	`setPostalCode(java.lang.String value)` Sets the postal code.
`void`	`setPrepay(boolean value)` Sets the is prepay flag.
`void`	`setShipforId(java.lang.String value)` Sets the ship-for customer id.
`void`	`setState(State value)` Sets the state/province object.
`private void`	`setStateCode(java.lang.String value)` Sets the state/province code.
`void`	`setStatusCode(java.lang.String value)` Sets the status code (defined by backend).
`void`	`setStatusText(java.lang.String value)` Sets the status code text (defined by backend).
`void`	`setXrefCode(java.lang.String value)` Sets the product cross reference code.
`boolean`	`shouldExclude()` (not persisted) Answers if the customer should be excluded from processing (customer is default customer or is one-time shipto customer or is deleted).

Methods inherited from class com.dpslink.base.jdbc.JDBCObject
after, before, compareTo, equals, fmtStatus, fmtStatus, getObjectStatus, hashKey, setObjectStatus

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject
cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CUST
```
public static final java.lang.String DEFAULT_CUST
```
    A constant that defines the default customer for a retail site.
    
    See Also:
    
    Constant Field Values
  - ONETIME_SHIPTO
```
public static final java.lang.String ONETIME_SHIPTO
```
    A constant that defines the customer id for a one-time ship-to.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Customer
```
public Customer()
```
    Constructs a Customer object with all field values set to null. Initializes the following flags and values based on configured defaults.
    
    setCommercial() Customer.Commercial.Default
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Returns the unique id for the customer.
    
    Returns:
    
    String - The unique id for the customer.
  - setId
```
public void setId(java.lang.String value)
```
    Sets the unique id for the customer.
    
    Parameters:
    
    value - (String) The unique id for the customer.
  - getBilltoId
```
public java.lang.String getBilltoId()
```
    Returns the bill-to customer id.
    
    Returns:
    
    String - The bill-to customer id.
  - setBilltoId
```
public void setBilltoId(java.lang.String value)
```
    Sets the bill-to customer id.
    
    Parameters:
    
    value - (String) The bill-to customer id.
  - getShipforId
```
public java.lang.String getShipforId()
```
    Returns the ship-for customer id.
    
    Returns:
    
    String - The ship-for customer id.
  - setShipforId
```
public void setShipforId(java.lang.String value)
```
    Sets the ship-for customer id.
    
    Parameters:
    
    value - (String) The ship-for customer id.
  - getName
```
public java.lang.String getName()
```
    Returns the name.
    
    Returns:
    
    String - The name.
  - setName
```
public void setName(java.lang.String value)
```
    Sets the name.
    
    Parameters:
    
    value - (String) The name.
  - getAddress1
```
public java.lang.String getAddress1()
```
    Returns the address line 1.
    
    Returns:
    
    String - The address line 1.
  - setAddress1
```
public void setAddress1(java.lang.String value)
```
    Sets the address line 1.
    
    Parameters:
    
    value - (String) The address line 1.
  - getAddress2
```
public java.lang.String getAddress2()
```
    Returns the address line 2.
    
    Returns:
    
    String - The address line 2.
  - setAddress2
```
public void setAddress2(java.lang.String value)
```
    Sets the address line 2.
    
    Parameters:
    
    value - (String) The address line 2.
  - getAddress3
```
public java.lang.String getAddress3()
```
    Returns the address line 3.
    
    Returns:
    
    String - The address line 3.
  - setAddress3
```
public void setAddress3(java.lang.String value)
```
    Sets the address line 3.
    
    Parameters:
    
    value - (String) The address line 3.
  - getAddress4
```
public java.lang.String getAddress4()
```
    Returns the address line 4.
    
    Returns:
    
    String - The address line 4.
  - setAddress4
```
public void setAddress4(java.lang.String value)
```
    Sets the address line 4.
    
    Parameters:
    
    value - (String) The address line 4.
  - getCity
```
public java.lang.String getCity()
```
    Returns the city.
    
    Returns:
    
    String - The city.
  - setCity
```
public void setCity(java.lang.String value)
```
    Sets the city.
    
    Parameters:
    
    value - (String) The city.
  - getState
```
public State getState()
```
    Returns the state/province object.
    
    Returns:
    
    State - The state/province object.
  - setState
```
public void setState(State value)
```
    Sets the state/province object.
    
    Parameters:
    
    value - (State) The state/province object.
  - getStateCode
```
public java.lang.String getStateCode()
```
    Returns the state/province code.
    
    Returns:
    
    String - The state/province code.
  - setStateCode
```
private void setStateCode(java.lang.String value)
```
    Sets the state/province code.
    
    Parameters:
    
    value - (String) The state/province code.
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    Returns the postal code.
    
    Returns:
    
    String - The postal code.
  - setPostalCode
```
public void setPostalCode(java.lang.String value)
```
    Sets the postal code.
    
    Parameters:
    
    value - (String) The postal code.
  - getCountry
```
public Country getCountry()
```
    Returns the country object.
    
    Returns:
    
    Country - The country object.
  - setCountry
```
public void setCountry(Country value)
```
    Sets the country object.
    
    Parameters:
    
    value - (Country) The country object.
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    Returns the country code.
    
    Returns:
    
    String - The country code.
  - setCountryCode
```
private void setCountryCode(java.lang.String value)
```
    Sets the country code.
    
    Parameters:
    
    value - (String) The country code.
  - getStatusCode
```
public java.lang.String getStatusCode()
```
    Returns the status code (defined by backend).
    
    Returns:
    
    String - The status code (defined by backend).
  - setStatusCode
```
public void setStatusCode(java.lang.String value)
```
    Sets the status code (defined by backend).
    
    Parameters:
    
    value - (String) The status code (defined by backend).
  - getStatusText
```
public java.lang.String getStatusText()
```
    Returns the status code text (defined by backend).
    
    Returns:
    
    String - The status code text (defined by backend).
  - setStatusText
```
public void setStatusText(java.lang.String value)
```
    Sets the status code text (defined by backend).
    
    Parameters:
    
    value - (String) The status code text (defined by backend).
  - getXrefCode
```
public java.lang.String getXrefCode()
```
    Returns the product cross reference code.
    
    Returns:
    
    String - The product cross reference code.
  - setXrefCode
```
public void setXrefCode(java.lang.String value)
```
    Sets the product cross reference code.
    
    Parameters:
    
    value - (String) The product cross reference code.
  - getPrepay
```
public boolean getPrepay()
```
    Returns the is prepay flag.
    
    Returns:
    
    boolean - The is prepay flag.
  - setPrepay
```
public void setPrepay(boolean value)
```
    Sets the is prepay flag.
    
    Parameters:
    
    value - (boolean) The is prepay flag.
  - getPhone
```
public java.lang.String getPhone()
```
    Returns the phone number.
    
    Returns:
    
    String - The phone number.
  - setPhone
```
public void setPhone(java.lang.String value)
```
    Sets the phone number.
    
    Parameters:
    
    value - (String) The phone number.
  - getFax
```
public java.lang.String getFax()
```
    Returns the fax number.
    
    Returns:
    
    String - The fax number.
  - setFax
```
public void setFax(java.lang.String value)
```
    Sets the fax number.
    
    Parameters:
    
    value - (String) The fax number.
  - getARPhone
```
public java.lang.String getARPhone()
```
    Returns the A/R phone number.
    
    Returns:
    
    String - The A/R phone number.
  - setARPhone
```
public void setARPhone(java.lang.String value)
```
    Sets the A/R phone number.
    
    Parameters:
    
    value - (String) The A/R phone number.
  - getARFax
```
public java.lang.String getARFax()
```
    Returns the A/R fax number.
    
    Returns:
    
    String - The A/R fax number.
  - setARFax
```
public void setARFax(java.lang.String value)
```
    Sets the A/R fax number.
    
    Parameters:
    
    value - (String) The A/R fax number.
  - getEmailAddr
```
public java.lang.String getEmailAddr()
```
    Returns the email address.
    
    Returns:
    
    String - The email address.
  - setEmailAddr
```
public void setEmailAddr(java.lang.String value)
```
    Sets the email address.
    
    Parameters:
    
    value - (String) The email address.
  - getCommercial
```
public boolean getCommercial()
```
    Returns the is commerical address flag.
    
    Returns:
    
    boolean - The is commerical address flag.
  - setCommercial
```
public void setCommercial(boolean value)
```
    Sets the is commerical address flag.
    
    Parameters:
    
    value - (boolean) The is commerical address flag.
  - getContactName
```
public java.lang.String getContactName()
```
    (not persisted) Returns the contact name.
    
    Returns:
    
    String - The contact name.
  - setContactName
```
public void setContactName(java.lang.String value)
```
    (not persisted) Sets the contact name.
    
    Parameters:
    
    value - (String) The contact name.
  - getContactPhone
```
public java.lang.String getContactPhone()
```
    (not persisted) Returns the contact phone number.
    
    Returns:
    
    String - The contact phone number.
  - setContactPhone
```
public void setContactPhone(java.lang.String value)
```
    (not persisted) Sets the contact phone number.
    
    Parameters:
    
    value - (String) The contact phone number.
  - getIsPersisted
```
public boolean getIsPersisted()
```
    (not persisted) Returns the is persisted flag.
    
    Returns:
    
    boolean - The is persisted flag.
  - setIsPersisted
```
public void setIsPersisted(boolean value)
```
    (not persisted) Sets the is persisted flag.
    
    Parameters:
    
    value - (boolean) The is persisted flag.
  - getVerificationAddress
```
public java.lang.String getVerificationAddress()
```
    (not persisted) Returns the customer's address used for verifying credit card transactions. This will be the first non-blank address line for the customer.
    
    Returns:
    
    String - The customer's verification address.
  - getVerificationPostalCode
```
public java.lang.String getVerificationPostalCode()
```
    (not persisted) Returns the customer's postal code used for verifying credit card transactions. For U.S. customers, this is the first 5 digits of the postal code (zip code excluding the plus 4 portion).
    
    Returns:
    
    String - The customer's verification postal code.
  - isDefaultCustomer
```
public boolean isDefaultCustomer()
```
    (not persisted) Answers if the customer is the default customer.
    
    Returns:
    
    boolean - true if the customer is the default customer, otherwise false.
  - isOneTimeShipto
```
public boolean isOneTimeShipto()
```
    (not persisted) Answers if the customer is a one-time ship-to.
    
    Returns:
    
    boolean - true if the customer is a one-time ship-to, otherwise false.
  - isStatusDelete
```
public boolean isStatusDelete()
```
    (not persisted) Answers if the customer status is delete.
    
    Returns:
    
    boolean - true if the customer status is delete, otherwise false.
  - shouldExclude
```
public boolean shouldExclude()
```
    (not persisted) Answers if the customer should be excluded from processing (customer is default customer or is one-time shipto customer or is deleted).
    
    Returns:
    
    boolean - true if the customer should be excluded, otherwise false.

Class Customer

Field Summary

Fields inherited from class com.dpslink.base.jdbc.JDBCObject

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

Constructor Summary

Method Summary

Methods inherited from class com.dpslink.base.jdbc.JDBCObject

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

DEFAULT_CUST

ONETIME_SHIPTO

Constructor Detail

Customer

Method Detail

getId

setId

getBilltoId

setBilltoId

getShipforId

setShipforId

getName

setName

getAddress1

setAddress1

getAddress2

setAddress2

getAddress3

setAddress3

getAddress4

setAddress4

getCity

setCity

getState

setState

getStateCode

setStateCode

getPostalCode

setPostalCode

getCountry

setCountry

getCountryCode

setCountryCode

getStatusCode

setStatusCode

getStatusText

setStatusText

getXrefCode

setXrefCode

getPrepay

setPrepay

getPhone

setPhone

getFax

setFax

getARPhone

setARPhone

getARFax

setARFax

getEmailAddr

setEmailAddr

getCommercial

setCommercial

getContactName

setContactName

getContactPhone

setContactPhone

getIsPersisted

setIsPersisted

getVerificationAddress

getVerificationPostalCode

isDefaultCustomer

isOneTimeShipto

isStatusDelete

shouldExclude