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

Class CreateAccountUserRequest

java.lang.Object
com.broadleafcommerce.customer.web.endpoint.domain.CreateAccountUserRequest
All Implemented Interfaces:
Serializable
public class CreateAccountUserRequest extends Object implements Serializable
DTO used to create a new account user.
Since:
Customer Services 2.1.0, Release Train 2.3.0
Author:
Sunny Yu
See Also:

  • Constructor Details

    • CreateAccountUserRequest

      public CreateAccountUserRequest()

  • Method Details

    • getFirstName

      public String getFirstName()
      The first name of the customer, if the fullName is not being used for the customer.

    • getMiddleName

      public String getMiddleName()
      The middle name of the customer, if the fullName is not being used for the customer.

    • getLastName

      public String getLastName()
      The last name of the customer, if the fullName is not being used for the customer.
      Returns:
      the last name of the customer

    • getFullName

      public String getFullName()
      The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.

    • getUsername

      public String getUsername()
      The username of the customer, used to log in.

    • getEmail

      public String getEmail()
      The email address of the customer.

    • getPhone

      public Phone getPhone()
      The phone number of the customer.

    • getAccountRoleIds

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

    • getAccountPermissionIds

      public Set<String> getAccountPermissionIds()
      The customer's permissions within the account. These map to permission IDs in the auth service.

    • getRestrictions

      public List<AccessRestriction> getRestrictions()
      The data restrictions that control the data this user is permitted to access.

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

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

    • getStatus

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

    • 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

    • setFirstName

      public void setFirstName(String firstName)
      The first name of the customer, if the fullName is not being used for the customer.

    • setMiddleName

      public void setMiddleName(String middleName)
      The middle name of the customer, if the fullName is not being used for the customer.

    • setLastName

      public void setLastName(String lastName)
      The last name of the customer, if the fullName is not being used for the customer.

    • setFullName

      public void setFullName(String fullName)
      The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.

    • setUsername

      public void setUsername(String username)
      The username of the customer, used to log in.

    • setEmail

      public void setEmail(String email)
      The email address of the customer.

    • setPhone

      public void setPhone(Phone phone)
      The phone number of the customer.

    • setAccountRoleIds

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

    • setAccountPermissionIds

      public void setAccountPermissionIds(Set<String> accountPermissionIds)
      The customer's permissions within the account. These map to permission IDs in the auth service.

    • setRestrictions

      public void setRestrictions(List<AccessRestriction> restrictions)
      The data restrictions that control the data this user is permitted to access.

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

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

    • setStatus

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

    • 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