Interface GroupProvider

  • All Known Implementing Classes:
    DefaultGroupProvider

    public interface GroupProvider
    In charge of providing groups.
    Author:
    mmoquillon
    • Method Detail

      • get

        static GroupProvider get()
        Gets the instance of the implementation of the interface.
        Returns:
        an implementation of GroupProvider.
      • getGroup

        Group getGroup​(String groupId)
        Gets a group of users from the specified identifier.
        Parameters:
        groupId - a group identifier as string.
        Returns:
        a group instance of Group.
      • getAllRootGroups

        List<Group> getAllRootGroups()
        Gets all GroupState.VALID root groups in Silverpeas. A root group is the group of users without any other parent group.
        Returns:
        a list of root groups.
      • getAllRootGroupsInDomain

        List<Group> getAllRootGroupsInDomain​(String domainId)
        Gets all GroupState.VALID root groups of users that are defined in the specified domain in Silverpeas.
        Parameters:
        domainId - the unique identifier of a Silverpeas domain.
        Returns:
        a list of root groups belonging to the specified domain.