Package org.broadleafcommerce.profile.core.domain

Interface Customer

All Superinterfaces:
MultiTenantCloneable<Customer>, Serializable
All Known Implementing Classes:
CustomerImpl
public interface Customer extends Serializable, MultiTenantCloneable<Customer>

  • Method Details

    • 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)

    • isCookied

      boolean isCookied()

    • setCookied

      void setCookied(boolean cookied)

    • isLoggedIn

      boolean isLoggedIn()

    • setLoggedIn

      void setLoggedIn(boolean loggedIn)

    • isAnonymous

      boolean isAnonymous()

    • setAnonymous

      void setAnonymous(boolean anonymous)

    • 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

    • 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

    • 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: