Package com.broadleafcommerce.customer.domain

Class AccountMember

java.lang.Object
com.broadleafcommerce.customer.domain.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:

  • Constructor Details

    • AccountMember

      public AccountMember()

  • Method Details

    • isActive

      @Deprecated(forRemoval=true, since="Customer Services 2.1.0, Release Train 2.3.0") public boolean isActive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      in favor of status since Customer Services 2.1.0, Release Train 2.3.0
      Determines whether the account member is active.

    • setActive

      @Deprecated(forRemoval=true, since="Customer Services 2.1.0, Release Train 2.3.0") public void setActive(boolean active)
      Deprecated, for removal: This API element is subject to removal in a future version.
      in favor of status since Customer Services 2.1.0, Release Train 2.3.0

    • setStatus

      public void setStatus(String status)
      Temporary setter override to keep active in sync with status without having to call setActive(boolean), subject to removal when active is removed.

    • 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

    • getDefaultCommunicationPreference

      public String getDefaultCommunicationPreference()
      The default communication preference of the account member.
      Returns:
      the default communication preference of the account member

    • getStatus

      public String getStatus()
      Specifies the status of the account member.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0
      See Also:

    • getRestrictions

      public List<AccessRestriction> getRestrictions()
      The data restrictions that control the data this user is permitted to access.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • getRestrictedRoles

      public List<RestrictedRole> getRestrictedRoles()
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • getRestrictedPermissions

      public List<RestrictedPermission> getRestrictedPermissions()
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • 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

    • 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

    • setDefaultCommunicationPreference

      public void setDefaultCommunicationPreference(String defaultCommunicationPreference)
      The default communication preference of the account member.
      Parameters:
      communicationPreference - the default communication preference of the account member

    • setRestrictions

      public void setRestrictions(List<AccessRestriction> restrictions)
      The data restrictions that control the data this user is permitted to access.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • setRestrictedRoles

      public void setRestrictedRoles(List<RestrictedRole> restrictedRoles)
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • setRestrictedPermissions

      public void setRestrictedPermissions(List<RestrictedPermission> restrictedPermissions)
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
      Since:
      Customer Services 2.1.0, Release Train 2.3.0

    • 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

    • 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