Package io.jmix.security.model

Class BaseRole

java.lang.Object
io.jmix.security.model.BaseRole
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ResourceRole, RowLevelRole
public abstract class BaseRole extends Object implements Serializable
See Also:

  • Constructor Details

    • BaseRole

      public BaseRole()

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getCode

      public String getCode()

    • setCode

      public void setCode(String code)

    • getSource

      public String getSource()

    • setSource

      public void setSource(String source)

    • getCustomProperties

      public Map<String,String> getCustomProperties()

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getNameMessageKey

      public String getNameMessageKey()
      Returns:
      the key of the message that localizes the name, when the role declares its name as a msg:// reference; getName() then holds the message in the default locale, or the key when that message is missing or blank

    • setNameMessageKey

      public void setNameMessageKey(String nameMessageKey)

    • getDescriptionMessageKey

      public String getDescriptionMessageKey()
      Returns:
      the key of the message that localizes the description, when the role declares its description as a msg:// reference; getDescription() then holds the message in the default locale, or the key when that message is missing

    • setDescriptionMessageKey

      public void setDescriptionMessageKey(String descriptionMessageKey)

    • getLocalizedNames

      public String getLocalizedNames()
      Returns:
      the name localized to other locales, in Properties format keyed by locale, such as de=Leiter

    • setLocalizedNames

      public void setLocalizedNames(String localizedNames)

    • getLocalizedDescriptions

      public String getLocalizedDescriptions()
      Returns:
      the description localized to other locales, in Properties format keyed by locale

    • setLocalizedDescriptions

      public void setLocalizedDescriptions(String localizedDescriptions)

    • getChildRoles

      public Set<String> getChildRoles()
      Returns:
      the codes of the roles whose policies this role includes; for a role defined by an annotated interface, these are the role interfaces it extends

    • setChildRoles

      public void setChildRoles(Set<String> childRoles)

    • setCustomProperties

      public void setCustomProperties(Map<String,String> customProperties)

    • getTenantId

      public String getTenantId()

    • setTenantId

      public void setTenantId(String tenantId)