Customer (BroadleafCommerce Profile 6.2.1.2-GA API)

All Superinterfaces:

MultiTenantCloneable<Customer>, Serializable

All Known Implementing Classes:

CustomerImpl
```
public interface Customer
extends Serializable, MultiTenantCloneable<Customer>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Auditable`	`getAuditable()`
`String`	`getChallengeAnswer()`
`ChallengeQuestion`	`getChallengeQuestion()`
`List<CustomerAddress>`	`getCustomerAddresses()`
`Map<String,CustomerAttribute>`	`getCustomerAttributes()`
`Locale`	`getCustomerLocale()`
`List<CustomerPayment>`	`getCustomerPayments()`
`List<CustomerPhone>`	`getCustomerPhones()`
`String`	`getEmailAddress()`
`String`	`getExternalId()`
`String`	`getFirstName()`
`Long`	`getId()`
`String`	`getLastName()`
`String`	`getPassword()`
`String`	`getTaxExemptionCode()` The code used by an external system to determine if the user is tax exempt and/or what specific taxes the user is exempt from.
`Map<String,Object>`	`getTransientProperties()` This returns a non-null map of transient properties that are not persisted to the database.
`String`	`getUnencodedChallengeAnswer()`
`String`	`getUnencodedPassword()`
`String`	`getUsername()`
`boolean`	`isAnonymous()`
`boolean`	`isCookied()`
`boolean`	`isDeactivated()` Returns true if this user has been deactivated.
`boolean`	`isLoggedIn()`
`boolean`	`isPasswordChangeRequired()` If true, this customer must go through a reset password flow.
`boolean`	`isReceiveEmail()`
`boolean`	`isRegistered()`
`boolean`	`isTaxExempt()` Convenience method to represent if this customer should be taxed or not when pricing their `Order`.
`void`	`setAnonymous(boolean anonymous)`
`void`	`setAuditable(Auditable auditable)`
`void`	`setChallengeAnswer(String challengeAnswer)`
`void`	`setChallengeQuestion(ChallengeQuestion challengeQuestion)`
`void`	`setCookied(boolean cookied)`
`void`	`setCustomerAddresses(List<CustomerAddress> customerAddresses)`
`void`	`setCustomerAttributes(Map<String,CustomerAttribute> customerAttributes)`
`void`	`setCustomerLocale(Locale customerLocale)`
`void`	`setCustomerPayments(List<CustomerPayment> customerPayments)`
`void`	`setCustomerPhones(List<CustomerPhone> customerPhones)`
`void`	`setDeactivated(boolean deactivated)` Sets the users deactivated status.
`void`	`setEmailAddress(String emailAddress)`
`void`	`setExternalId(String externalId)`
`void`	`setFirstName(String firstName)`
`void`	`setId(Long id)`
`void`	`setLastName(String lastName)`
`void`	`setLoggedIn(boolean loggedIn)`
`void`	`setPassword(String password)`
`void`	`setPasswordChangeRequired(boolean passwordChangeRequired)`
`void`	`setReceiveEmail(boolean receiveEmail)`
`void`	`setRegistered(boolean registered)`
`void`	`setTaxExemptionCode(String exemption)` Associates a tax exemption code to this user to notate tax exemption status.
`void`	`setUnencodedChallengeAnswer(String unencodedChallengeAnswer)`
`void`	`setUnencodedPassword(String unencodedPassword)`
`void`	`setUsername(String username)`

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance

- Method Detail
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getUsername
```
String getUsername()
```
  - setUsername
```
void setUsername(String username)
```
  - getPassword
```
String getPassword()
```
  - setPassword
```
void setPassword(String password)
```
  - isPasswordChangeRequired
```
boolean isPasswordChangeRequired()
```
    If true, this customer must go through a reset password flow.
    
    During a site conversion or security breach or a matter of routine security policy, it may be necessary to require users to change their password. This property will not allow a user whose credentials are managed within Broadleaf to login until they have reset their password.
    
    Used by blUserDetailsService.
  - setPasswordChangeRequired
```
void setPasswordChangeRequired(boolean passwordChangeRequired)
```
  - getFirstName
```
String getFirstName()
```
  - setFirstName
```
void setFirstName(String firstName)
```
  - getLastName
```
String getLastName()
```
  - setLastName
```
void setLastName(String lastName)
```
  - getEmailAddress
```
String getEmailAddress()
```
  - setEmailAddress
```
void setEmailAddress(String emailAddress)
```
  - getExternalId
```
String getExternalId()
```
  - setExternalId
```
void setExternalId(String externalId)
```
  - getChallengeQuestion
```
ChallengeQuestion getChallengeQuestion()
```
  - setChallengeQuestion
```
void setChallengeQuestion(ChallengeQuestion challengeQuestion)
```
  - getChallengeAnswer
```
String getChallengeAnswer()
```
  - setChallengeAnswer
```
void setChallengeAnswer(String challengeAnswer)
```
  - getUnencodedPassword
```
String getUnencodedPassword()
```
  - setUnencodedPassword
```
void setUnencodedPassword(String unencodedPassword)
```
  - isReceiveEmail
```
boolean isReceiveEmail()
```
  - setReceiveEmail
```
void setReceiveEmail(boolean receiveEmail)
```
  - isRegistered
```
boolean isRegistered()
```
  - setRegistered
```
void setRegistered(boolean registered)
```
  - getUnencodedChallengeAnswer
```
String getUnencodedChallengeAnswer()
```
  - setUnencodedChallengeAnswer
```
void setUnencodedChallengeAnswer(String unencodedChallengeAnswer)
```
  - getAuditable
```
Auditable getAuditable()
```
  - setAuditable
```
void setAuditable(Auditable auditable)
```
  - setCookied
```
void setCookied(boolean cookied)
```
  - isCookied
```
boolean isCookied()
```
  - setLoggedIn
```
void setLoggedIn(boolean loggedIn)
```
  - isLoggedIn
```
boolean isLoggedIn()
```
  - setAnonymous
```
void setAnonymous(boolean anonymous)
```
  - isAnonymous
```
boolean isAnonymous()
```
  - getCustomerLocale
```
Locale getCustomerLocale()
```
  - setCustomerLocale
```
void setCustomerLocale(Locale customerLocale)
```
  - getCustomerAttributes
```
Map<String,CustomerAttribute> getCustomerAttributes()
```
  - setCustomerAttributes
```
void setCustomerAttributes(Map<String,CustomerAttribute> customerAttributes)
```
  - isDeactivated
```
boolean isDeactivated()
```
    Returns true if this user has been deactivated. Most implementations will not allow the user to login if they are deactivated.
    
    Returns:
  - setDeactivated
```
void setDeactivated(boolean deactivated)
```
    Sets the users deactivated status.
    
    Parameters:
    
    deactivated -
  - getCustomerAddresses
```
List<CustomerAddress> getCustomerAddresses()
```
  - setCustomerAddresses
```
void setCustomerAddresses(List<CustomerAddress> customerAddresses)
```
  - getCustomerPhones
```
List<CustomerPhone> getCustomerPhones()
```
  - setCustomerPhones
```
void setCustomerPhones(List<CustomerPhone> customerPhones)
```
  - getCustomerPayments
```
List<CustomerPayment> getCustomerPayments()
```
  - setCustomerPayments
```
void setCustomerPayments(List<CustomerPayment> customerPayments)
```
  - getTaxExemptionCode
```
String getTaxExemptionCode()
```
    The code used by an external system to determine if the user is tax exempt and/or what specific taxes the user is exempt from.
    
    Returns:
    
    the code for this user's tax exemption reason, usually to just be passed to an external system
    
    See Also:
    
    #isTaxExempt()}
  - setTaxExemptionCode
```
void setTaxExemptionCode(String exemption)
```
    Associates a tax exemption code to this user to notate tax exemption status. Default behavior in the org.broadleafcommerce.core.pricing.service.tax.provider.SimpleTaxProvider is that if this is set to any value then this customer is tax exempt.
    
    Parameters:
    
    exemption - the tax exemption code for the customer
    
    See Also:
    
    #isTaxExempt()}
  - isTaxExempt
```
boolean isTaxExempt()
```
    Convenience method to represent if this customer should be taxed or not when pricing their Order. Default behavior in the org.broadleafcommerce.core.pricing.service.tax.provider.SimpleTaxProvider is that if there is anything in getTaxExemptionCode() then the customer is exempt.
    If you assign special meaning to the getTaxExemptionCode() then this might be different and you should determine specific tax exemption based on getTaxExemptionCode()
    
    Returns:
    
    whether or not this customer is exempt from tax calculations
  - getTransientProperties
```
Map<String,Object> getTransientProperties()
```
    This returns a non-null map of transient properties that are not persisted to the database.
    
    Returns:

Interface Customer

Method Summary

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

Method Detail

getId

setId

getUsername

setUsername

getPassword

setPassword

isPasswordChangeRequired

setPasswordChangeRequired

getFirstName

setFirstName

getLastName

setLastName

getEmailAddress

setEmailAddress

getExternalId

setExternalId

getChallengeQuestion

setChallengeQuestion

getChallengeAnswer

setChallengeAnswer

getUnencodedPassword

setUnencodedPassword

isReceiveEmail

setReceiveEmail

isRegistered

setRegistered

getUnencodedChallengeAnswer

setUnencodedChallengeAnswer

getAuditable

setAuditable

setCookied

isCookied

setLoggedIn

isLoggedIn

setAnonymous

isAnonymous

getCustomerLocale

setCustomerLocale

getCustomerAttributes

setCustomerAttributes

isDeactivated

setDeactivated

getCustomerAddresses

setCustomerAddresses

getCustomerPhones

setCustomerPhones

getCustomerPayments

setCustomerPayments

getTaxExemptionCode

setTaxExemptionCode

isTaxExempt

getTransientProperties