Interface IAnyGroup

All Known Implementing Classes:
AnyGroup

public interface IAnyGroup
The Interface IAnyGroup. The group identifier is its name.

Users and groups members of the group are identified by their respective identifier (group name for the group and user login for the user).

  • Method Details

    • getId

      String getId()
      Gets the id (group name).
      Returns:
      the id
    • setId

      void setId(String id)
      Sets the id (group name).

      Group identifier is required and must be only composed with lower case characters, underscore and number. Group identifier maximum length is 128 characters.

      Parameters:
      id - the new id
    • containsDescription

      boolean containsDescription()
      Description of group is set.
      Returns:
      true, if group description is set.
    • getDescription

      String getDescription()
      Gets the description.
      Returns:
      the description
    • setDescription

      void setDescription(String description)
      Sets the description.
      Parameters:
      description - the new description
    • containsApplications

      boolean containsApplications()
      List of applications assigned to this group is set.
      Returns:
      true, if group applications is set.
    • getApplications

      List<String> getApplications()
      Gets the applications.
      Returns:
      the application names
    • setApplications

      void setApplications(List<String> applications)
      Sets the application names assigned to the group.
      Parameters:
      applications - the new applications
    • containsRoles

      boolean containsRoles()
      List of group roles is set.
      Returns:
      true, if any group role is set.
    • getRoles

      List<String> getRoles()
      Gets the list of roles.
      Returns:
      the roles
    • setRoles

      void setRoles(List<String> roles)
      Sets the list of roles.
      Parameters:
      roles - the new roles
    • containsGroups

      boolean containsGroups()
      List of groups included in this group is set.
      Returns:
      true, if list of groups included is set
    • getGroups

      List<String> getGroups()
      Gets the groups included in this group.
      Returns:
      the groups
    • setGroups

      void setGroups(List<String> groups)
      Sets the groups included in this group.

      If you use this method you cannot use setMembers(List).

      Parameters:
      groups - the new groups
    • containsMembers

      boolean containsMembers()
      List of members included in this group is set.

      Members list is a mixed list of users and groups. If you use this method you cannot use containsUsers() or containsGroups()

      Returns:
      true, if members in this group is set
    • getMembers

      List<String> getMembers()
      Gets the members. A member can be a user or a group.

      Members list is a mixed list of users and groups. If you use this method you cannot use getUsers() or getGroups()

      Returns:
      the members
    • setMembers

      void setMembers(List<String> members)
      Sets the members list.

      A member can be a user or a group. If you use this method you cannot use setUsers(List) or setGroups(List).

      Parameters:
      members - the new members
    • containsUsers

      boolean containsUsers()
      List of users included in this group is set.
      Returns:
      true, if list of users is set
    • getUsers

      List<String> getUsers()
      Gets the users.
      Returns:
      the users list
    • setUsers

      void setUsers(List<String> users)
      Sets the users. If you use this method you cannot use setMembers(List).
      Parameters:
      users - the new users