Package com.broadleafcommerce.customer.domain

Class AccountMember

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
    public class AccountMember
extends Object
implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
    Representation of a Customer's relationship with an Account, their contact info, & the role that they have for the account.
    Author:
    Chris Kittrell (ckittrell)
    See Also:
    Serialized Form

    • Constructor Detail

      • AccountMember

        public AccountMember()

    • Method Detail

      • getId

        public String getId()
        The context ID of the relationship.
        Returns:
        the context ID of the relationship

      • getAccount

        public Account getAccount()
        The account in the relationship.
        Returns:
        the account in the relationship

      • getCustomer

        public Customer getCustomer()
        The customer in the relationship.
        Returns:
        the customer in the relationship

      • getAccountRoleIds

        public Set<String> getAccountRoleIds()
        The customer's roles within the account. These map to role IDs in the auth service.
        Returns:
        The customer's roles within the account.

      • getEmail

        public String getEmail()
        The email address of the account member if they are not a registered customer at the time of invite.
        Returns:
        the email address of the account member

      • getPhone

        public Phone getPhone()
        The main phone number of the account member if they are not a registered customer at the time of invite.
        Returns:
        the main phone number of the account member

      • getAdditionalPhones

        @Deprecated
public List<AdditionalPhone> getAdditionalPhones()
        Deprecated.
        Use the customer's additional phones instead
        Additional phone numbers associated with the account member.
        Returns:
        additional phone numbers associated with the account member

      • getAttributes

        public Map<String,​Object> getAttributes()
        Additional attributes that are used to describe the account member
        Returns:
        additional attributes that are used to describe the account member

      • getContextState

        public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Returns:
        a subset of Tracking information to expose the context state for this object

      • isActive

        public boolean isActive()
        Specifies whether this account member represents an invite (false) or an actual account member who has accepted the invite or was added via the Admin portal (true).
        Returns:
        whether the account member represents an invite (false) or an actual account member (true)

      • setId

        public void setId​(String id)
        The context ID of the relationship.
        Parameters:
        id - the context ID of the relationship

      • setAccount

        public void setAccount​(Account account)
        The account in the relationship.
        Parameters:
        accountRef - the account in the relationship

      • setCustomer

        public void setCustomer​(Customer customer)
        The customer in the relationship.
        Parameters:
        customer - the customer in the relationship

      • setAccountRoleIds

        public void setAccountRoleIds​(Set<String> accountRoleIds)
        The customer's roles within the account. These map to role IDs in the auth service.
        Parameters:
        accountRoleIds - The customer's roles within the account.

      • setEmail

        public void setEmail​(String email)
        The email address of the account member if they are not a registered customer at the time of invite.
        Parameters:
        email - the email address of the account member

      • setPhone

        public void setPhone​(Phone phone)
        The main phone number of the account member if they are not a registered customer at the time of invite.
        Parameters:
        phone - the main phone number of the account member

      • setAdditionalPhones

        @Deprecated
public void setAdditionalPhones​(List<AdditionalPhone> additionalPhones)
        Deprecated.
        Use the customer's additional phones instead
        Additional phone numbers associated with the account member.
        Parameters:
        additionalPhones - additional phone numbers associated with the account member

      • setAttributes

        public void setAttributes​(Map<String,​Object> attributes)
        Additional attributes that are used to describe the account member
        Parameters:
        attributes - additional attributes that are used to describe the account member

      • setContextState

        public void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Parameters:
        contextState - a subset of Tracking information to expose the context state for this object

      • setActive

        public void setActive​(boolean active)
        Specifies whether this account member represents an invite (false) or an actual account member who has accepted the invite or was added via the Admin portal (true).
        Parameters:
        active - whether the account member represents an invite (false) or an actual account member (true)N

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object