com.uc4.api.objects

Class UserAssignment

java.lang.Object

com.uc4.api.objects.UserAssignment

public class UserAssignment
extends java.lang.Object

This class enables the assignment of single users to this User Group.

Method Summary

Modifier and Type	Method and Description
boolean	addUser(UC4UserName userName) Adds a user to this UserGroup.
int	getMemberListSize()
int	getNoMemberListSize()
boolean	isRevision() Returns the Revision from this UserGroup.
java.util.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.
java.util.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.
boolean	removeUser(UC4UserName userName) Removes a user from this UserGroup.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

memberListIterator

public java.util.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 java.util.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.

addUser

public boolean addUser(UC4UserName userName)
                throws java.lang.IllegalStateException

Adds a user to this UserGroup.

Parameters:

userName - Name of the user

Returns:

true if successful, false if the operation failed

Throws:

java.lang.IllegalStateException - when revisioning is set

removeUser

public boolean removeUser(UC4UserName userName)
                   throws java.lang.IllegalStateException

Removes a user from this UserGroup.

Parameters:

userName - Name of the user

Returns:

true if successful, false if the operation failed

Throws:

java.lang.IllegalStateException - when revisioning is set

isRevision

public boolean isRevision()

Returns the Revision from this UserGroup.

Returns:

true/false