Package com.broadleafcommerce.customer.client.domain

Class CustomerRef

java.lang.Object
com.broadleafcommerce.customer.client.domain.CustomerRef
All Implemented Interfaces:
Serializable
public class CustomerRef extends Object implements Serializable
A reference to a customer. This is primarily useful when a CSR is acting in a storefront context and the CustomerSegmentContextInfoCustomizer needs information about a customer the CSR is acting on behalf of or who owns an entity being acted on by the CSR, e.g., a Quote.
Since:
Customer Client 1.0.1, Release Train 2.1.5
See Also:

  • Constructor Details

    • CustomerRef

      public CustomerRef()

  • Method Details

    • getCustomerId

      public String getCustomerId()
      The customer's id.
      Returns:
      The customer's id.

    • getUsername

      public String getUsername()
      The customer's username.
      Returns:
      The customer's username.

    • getEmail

      public String getEmail()
      The customer's email address.
      Returns:
      The customer's email address.

    • getPhoneNumber

      public String getPhoneNumber()
      The customer's phone number.
      Returns:
      The customer's phone number.

    • getFullName

      public String getFullName()
      The customer's full name, if available.
      Returns:
      The customer's full name, if available.

    • isRegistered

      public boolean isRegistered()
      Defines whether or not the customer is registered. If false, then the customer is considered anonymous.
      Returns:
      Whether or not the customer is registered.

    • getAccountId

      public String getAccountId()
      The ID of the account the customer belongs to.
      Returns:
      the ID of the account of the customer

    • getRootAccountId

      public String getRootAccountId()
      The ID of the root account the account member belongs to.
      Returns:
      The ID of the root account of the account member.

    • getAccountHierarchy

      public List<String> getAccountHierarchy()
      The hierarchy of accounts, from the root account to the account member's account.

      For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be [rootAcct, subAcct, subSubAcct]. This is useful to query all the carts that belong to the same non-root account and its sub-accounts.

      Returns:
      The hierarchy of accounts, from the root account to the account member's account.

    • setCustomerId

      public void setCustomerId(String customerId)
      The customer's id.
      Parameters:
      customerId - The customer's id.

    • setUsername

      public void setUsername(String username)
      The customer's username.
      Parameters:
      username - The customer's username.

    • setEmail

      public void setEmail(String email)
      The customer's email address.
      Parameters:
      email - The customer's email address.

    • setPhoneNumber

      public void setPhoneNumber(String phoneNumber)
      The customer's phone number.
      Parameters:
      username - The customer's phone number.

    • setFullName

      public void setFullName(String fullName)
      The customer's full name, if available.
      Parameters:
      fullName - The customer's full name.

    • setRegistered

      public void setRegistered(boolean isRegistered)
      Defines whether or not the customer is registered. If false, then the customer is considered anonymous.
      Parameters:
      isRegistered - Whether or not the customer is registered.

    • setAccountId

      public void setAccountId(String accountId)
      The ID of the account the customer belongs to.
      Parameters:
      accountId - the ID of the account of the customer

    • setRootAccountId

      public void setRootAccountId(String rootAccountId)
      The ID of the root account the account member belongs to.
      Parameters:
      rootAccountId - The ID of the root account of the account member.

    • setAccountHierarchy

      public void setAccountHierarchy(List<String> accountHierarchy)
      The hierarchy of accounts, from the root account to the account member's account.

      For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be [rootAcct, subAcct, subSubAcct]. This is useful to query all the carts that belong to the same non-root account and its sub-accounts.

      Parameters:
      accountHierarchy - The hierarchy of accounts, from the root account to the account member's account.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object