Package com.broadleafcommerce.customer.web.endpoint.domain

Class RegisterAccountMemberRequest

java.lang.Object
com.broadleafcommerce.customer.web.endpoint.domain.RegisterAccountMemberRequest
All Implemented Interfaces:
Serializable
public class RegisterAccountMemberRequest extends Object implements Serializable
Used to describe a new relationship between an Account & a Customer
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • RegisterAccountMemberRequest

      public RegisterAccountMemberRequest()

  • 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
      Note that when setting this value to false, it implies that the account invite is pending in the context of a register request,, therefore the status will be set to DefaultAccountMemberStatuses.INVITE_PENDING rather than DefaultAccountMemberStatuses.INACTIVE, unlike AccountMember.setActive(boolean).

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

    • getAccount

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

    • getCustomer

      public CustomerRef getCustomer()
      A pre-existing customer that is being granted access to the account.
      Returns:
      a pre-existing customer that is being granted access to the account

    • getAccountRoleIds

      public Set<String> getAccountRoleIds()
      The roles assigned to this AccountMember.
      Returns:
      The roles assigned to this account member.

    • getFirstName

      @Deprecated public String getFirstName()
      Deprecated.
      We use the customer's name instead.
      First name the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Returns:
      first name the account member

    • getLastName

      @Deprecated public String getLastName()
      Deprecated.
      We use the customer's name instead.
      Last name the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Returns:
      last name the account member

    • getUsername

      @Deprecated public String getUsername()
      Deprecated.
      We use the customer's username instead.
      Username for the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Returns:
      username for the account member

    • getEmail

      @Deprecated public String getEmail()
      Deprecated.
      We use the customer's email instead.
      Email address for the account member.
      Returns:
      an email address for the account member

    • getPhone

      @Deprecated public Phone getPhone()
      Deprecated.
      Use the customer's phone numbers instead
      The primary phone number of the account member.
      Returns:
      the primary phone number of the account member

    • getAdditionalPhones

      @Deprecated public List<AdditionalPhone> getAdditionalPhones()
      Deprecated.
      Use the customer's phone numbers 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

    • getStatus

      public String getStatus()
      Specifies the status of the account member.
      See Also:

    • setAccount

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

    • setCustomer

      public void setCustomer(CustomerRef customer)
      A pre-existing customer that is being granted access to the account.
      Parameters:
      customerRef - a pre-existing customer that is being granted access to the account

    • setAccountRoleIds

      public void setAccountRoleIds(Set<String> accountRoleIds)
      The roles assigned to this AccountMember.
      Parameters:
      accountRoleIds - The roles assigned to this account member.

    • setFirstName

      @Deprecated public void setFirstName(String firstName)
      Deprecated.
      We use the customer's name instead.
      First name the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Parameters:
      firstName - first name the account member

    • setLastName

      @Deprecated public void setLastName(String lastName)
      Deprecated.
      We use the customer's name instead.
      Last name the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Parameters:
      lastName - last name the account member

    • setUsername

      @Deprecated public void setUsername(String username)
      Deprecated.
      We use the customer's username instead.
      Username for the account member. This field is only relevant if a pre-existing customer is not identified by customer.
      Parameters:
      username - username for the account member

    • setEmail

      @Deprecated public void setEmail(String email)
      Deprecated.
      We use the customer's email instead.
      Email address for the account member.
      Parameters:
      email - an email address for the account member

    • setPhone

      @Deprecated public void setPhone(Phone phone)
      Deprecated.
      Use the customer's phone numbers instead
      The primary phone number of the account member.
      Parameters:
      phone - the primary phone number of the account member

    • setAdditionalPhones

      @Deprecated public void setAdditionalPhones(List<AdditionalPhone> additionalPhones)
      Deprecated.
      Use the customer's phone numbers 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

    • 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