Package org.nuxeo.client.objects.user

Class Group

    • Field Detail

      • groupName

        protected java.lang.String groupName

      • groupLabel

        protected java.lang.String groupLabel

      • memberUsers

        protected java.util.List<java.lang.String> memberUsers

      • memberGroups

        protected java.util.List<java.lang.String> memberGroups

      • parentGroups

        protected java.util.List<java.lang.String> parentGroups

    • Constructor Detail

      • Group

        public Group()

    • Method Detail

      • getGroupName

        public java.lang.String getGroupName()

      • setGroupName

        public void setGroupName​(java.lang.String groupName)

      • getGroupLabel

        public java.lang.String getGroupLabel()

      • setGroupLabel

        public void setGroupLabel​(java.lang.String groupLabel)

      • getMemberUsers

        public java.util.List<java.lang.String> getMemberUsers()
        Returns a list of member users if information is returned by server. This could be done by adding fetch.group=memberUsers header to request.

        This could be achieved with client API like this: 

         // if you want to apply header on all requests
 client.fetchPropertiesForGroup("memberUsers").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("memberUsers").fetchGroup("...");
        Returns:
        a list of member users

      • fetchMemberUsers

        public Users fetchMemberUsers()
        Returns a list of member users fetched from server. This method will perform a request and store the result on this object.
        Returns:
        a list of member users fetched from server
        Since:
        3.0

      • getMemberGroups

        public java.util.List<java.lang.String> getMemberGroups()
        Returns a list of member groups if information is returned by server. This could be done by adding fetch.group=memberGroups header to request.

        This could be achieved with client API like this: 

         // if you want to apply header on all requests
 client.fetchPropertiesForGroup("memberGroups").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("memberGroups").fetchGroup("...");
        Returns:
        a list of member groups

      • fetchMemberGroups

        public Groups fetchMemberGroups()
        Returns a list of member groups fetched from server. This method will perform a request and store the result on this object.
        Returns:
        a list of member groups fetched from server
        Since:
        3.0

      • getParentGroups

        public java.util.List<java.lang.String> getParentGroups()
        Returns a list of parent groups if information is returned by server. This could be done by adding fetch.group=parentGroups header to request.

        This could be achieved with client API like this: 

         // if you want to apply header on all requests
 client.fetchPropertiesForGroup("parentGroups").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("parentGroups").fetchGroup("...");

        CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10-HF19

        Returns:
        a list of parent groups
        Since:
        3.0

      • setParentGroups

        public void setParentGroups​(java.util.List<java.lang.String> parentGroups)
        Sets the parentGroups to this object. This method doesn't perform request to server. It must be used with UserManager.createGroup(Group) or UserManager.updateGroup(Group).

        CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10-HF19