Package com.uc4.api.objects

Class UserGroupAssignment

  • public class UserGroupAssignment
extends java.lang.Object
    This class enables the assignment of single users to user groups.

    • Constructor Detail

      • UserGroupAssignment

        protected UserGroupAssignment​(com.uc4.util.XMLDocument doc)

    • Method Detail

      • memberListIterator

        public java.util.Iterator<UC4ObjectName> memberListIterator()
        Returns a list of the client's user groups in which the user is a member. The returned java.util.Iterator cannot be used to remove user groups.
        Returns:
        Iterator to get a list of object names

      • noMemberListIterator

        public java.util.Iterator<UC4ObjectName> noMemberListIterator()
        Returns a list of the client's user groups in which the user is not a member. The returned java.util.Iterator cannot be used to remove user groups.
        Returns:
        Iterator to get a list of object names

      • getMemberListSize

        public int getMemberListSize()
        Returns:
        Number of User Groups in the member list

      • getNoMemberListSize

        public int getNoMemberListSize()
        Returns:
        Number of User Groups which are not in the member list

      • addUserToGroup

        public boolean addUserToGroup​(UC4ObjectName userGroup)
        Adds this User to the specified User Group.
        Parameters:
        userGroup - Name of the User Group
        Returns:
        true if successful, false if the operation failed

      • removeUserGroup

        public boolean removeUserGroup​(UC4ObjectName userGroup)
        Removes this User from the specified User Group.
        Parameters:
        userGroup - Name of the User Group
        Returns:
        true if successful, false if the operation failed

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element objectElement)