Package com.orchestranetworks.service.directory

# Interface DirectoryDefault.RoleEntity

Enclosing class:
  DirectoryDefault

public static interface DirectoryDefault.RoleEntity
Represents a role entity that is, or can be, persisted in the default directory.

Since:
  5.7.0
See Also:
  - `DirectoryDefaultHelper`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `UserMessage`
  `getDescription()`
  `String`
  `getEmail()`
  `List<Role>`
  `getIncludedRoles()`
  Never returns `null`.
  `UserMessage`
  `getLabel()`
  `String`
  `getName()`
  `void`
  `setDescription(UserMessage description)`
  `void`
  `setEmail(String email)`
  Allows to specify a mailing list associated with this role.
  `void`
  `setIncludedRoles(List<Role> includedRoles)`
  Specifies the roles included in this role.
  `void`
  `setLabel(UserMessage label)`

- ## Method Details

  - ### getName

    String getName()

  - ### getLabel

    UserMessage getLabel()

  - ### setLabel

    void setLabel(UserMessage label)

  - ### getDescription

    UserMessage getDescription()

  - ### setDescription

    void setDescription(UserMessage description)

  - ### getEmail

    String getEmail()

  - ### setEmail

    void setEmail(String email)
    Allows to specify a mailing list associated with this role. If defined, messages to be sent to this role will be sent to this email address instead of sending individual emails to users having this role.
    See Also:
      - `Directory.getRoleEmail(Role)`

  - ### getIncludedRoles

    List<Role> getIncludedRoles()
    Never returns `null`.

  - ### setIncludedRoles

    void setIncludedRoles(List<Role> includedRoles)
    Specifies the roles included in this role.
    See Also:
      - `Directory.isRoleStrictlyIncluded(Role, Role)`