Package org.broadleafcommerce.openadmin.server.security.domain

Interface AdminUser

All Superinterfaces:
AdminSecurityContext, Serializable
All Known Implementing Classes:
AdminUserImpl
public interface AdminUser extends AdminSecurityContext
Author:
jfischer

  • Method Details

    • getId

      Long getId()

    • setId

      void setId(Long id)

    • getName

      String getName()

    • setName

      void setName(String name)

    • getLogin

      String getLogin()

    • setLogin

      void setLogin(String login)

    • getPassword

      String getPassword()

    • setPassword

      void setPassword(String password)

    • getEmail

      String getEmail()

    • setEmail

      void setEmail(String email)

    • getAllRoles

      Set<AdminRole> getAllRoles()
      Specified by:
      getAllRoles in interface AdminSecurityContext

    • setAllRoles

      void setAllRoles(Set<AdminRole> allRoles)
      Specified by:
      setAllRoles in interface AdminSecurityContext

    • getUnencodedPassword

      String getUnencodedPassword()

    • setUnencodedPassword

      void setUnencodedPassword(String unencodedPassword)

    • getPhoneNumber

      String getPhoneNumber()
      Returns the users phone number.
      Returns:

    • setPhoneNumber

      void setPhoneNumber(String phone)
      Stores the user's phone number.
      Parameters:
      phone -

    • getActiveStatusFlag

      Boolean getActiveStatusFlag()
      Returns the users active status. A user whose active status is set to false will not be able to login.
      Returns:

    • setActiveStatusFlag

      void setActiveStatusFlag(Boolean activeStatus)
      Sets the users active status. A user whose active status is set to false will not be able to login.
      Parameters:
      activeStatus -

    • getOverrideSandBox

      SandBox getOverrideSandBox()
      The current sandbox associated with this user. This is primarily intended to be used by the BLC-CMS workflow processes.

      If null, the user is using their own SandBox.

      Returns:

    • setOverrideSandBox

      void setOverrideSandBox(SandBox sandbox)
      Overrides the user's sandbox. This could be used to setup shared sandboxes. Setting to null will mean that the user is setup to use the sandbox associated with their user.
      Parameters:
      sandbox -

    • getAllPermissions

      Set<AdminPermission> getAllPermissions()
      Specified by:
      getAllPermissions in interface AdminSecurityContext

    • setAllPermissions

      void setAllPermissions(Set<AdminPermission> allPermissions)
      Specified by:
      setAllPermissions in interface AdminSecurityContext

    • getFlatAdditionalFields

      Map<String,String> getFlatAdditionalFields()
      Returns a map representing just the key-value pairs inside the getAdditionalFields() map.
      Returns:
      the collapsed map

    • getAdditionalFields

      Map<String,AdminUserAttribute> getAdditionalFields()

    • setAdditionalFields

      void setAdditionalFields(Map<String,AdminUserAttribute> additionalFields)

    • getLastUsedSandBoxId

      Long getLastUsedSandBoxId()
      Returns:
      the id of the last sandbox this admin user used

    • setLastUsedSandBoxId

      void setLastUsedSandBoxId(Long sandBoxId)
      Sets the last used sandbox for this admin user
      Parameters:
      sandBoxId -