Package com.uc4.api.objects

Class UserAssignment

java.lang.Object
com.uc4.api.objects.UserAssignment
public class UserAssignment extends Object
This class enables the assignment of single users to this User Group.

  • Constructor Details

    • UserAssignment

      protected UserAssignment(com.uc4.util.XMLDocument doc)

  • Method Details

    • memberListIterator

      public Iterator<UC4UserName> memberListIterator()
      Returns a list of users who are members of this User Group The returned java.util.Iterator cannot be used to remove users.
      Returns:
      Iterator to get a list of user names

    • noMemberListIterator

      public Iterator<UC4UserName> noMemberListIterator()
      Returns a list of users who are not members of this User Group The returned java.util.Iterator cannot be used to remove users.
      Returns:
      Iterator to get a list of user names

    • getMemberListSize

      public int getMemberListSize()
      Returns:
      Number of Users who are part of this User Group.

    • getNoMemberListSize

      public int getNoMemberListSize()
      Returns:
      Number of Users who are not part of this User Group.

    • removeAllUsers

      public void removeAllUsers()
      Removes a all users from this UserGroup.
      Throws:
      IllegalStateException - when revisioning is set

    • addUser

      public boolean addUser(UC4UserName userName)
      Adds a user to this UserGroup.
      Parameters:
      userName - Name of the user
      Returns:
      true if successful, false if the operation failed
      Throws:
      IllegalStateException - when revisioning is set

    • removeUser

      public boolean removeUser(UC4UserName userName)
      Removes a user from this UserGroup.
      Parameters:
      userName - Name of the user
      Returns:
      true if successful, false if the operation failed
      Throws:
      IllegalStateException - when revisioning is set

    • isRevision

      public boolean isRevision()
      Returns the Revision from this UserGroup.
      Returns:
      true/false

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element objectElement)

    • isInNoMembersList

      public boolean isInNoMembersList(UC4UserName userName)
      Checks if the user is member of the group
      Parameters:
      userName - Name of the user
      Returns:
      true/false