|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.telelogic.cs.api.User
public class User
An immutable view of single user.
Constructor Summary | |
---|---|
User()
Do not call directly. |
|
User(com.telelogic.cs.user.UserInfo user)
Constructor to create a User object given a UserInfo object. |
Method Summary | |
---|---|
boolean |
getCanAccessApplet()
Determine if the user can currently access the applet or not. |
java.lang.String |
getContextDatabase()
Gets the context database that the user is currently logged into. |
java.lang.String |
getDatabase()
Gets the database that the user is currently logged into. |
java.lang.String |
getFormattedLastAccessedDate()
Gets the last accessed date as a formatted time string. |
java.lang.String |
getFormattedTimeoutDate()
Gets the the time when the user will timeout as a formatted string. |
java.util.List<java.lang.String> |
getGroups()
Get the list of groups that the user is currently a member of. |
long |
getLastAccessedDate()
Gets the time the user last had access to the server. |
java.lang.String |
getPrettyRole()
Gets the user's role. |
java.util.List<java.lang.String> |
getPrivileges()
Get an immutable list of the user's privileges (CM roles). |
java.lang.String |
getReadSecurityValue()
Gets the user's read security value. |
java.lang.String |
getRealName()
Same as getUserDisplayName() . |
java.lang.String |
getRole()
The user's role. |
long |
getTimeoutDate()
Gets the time when the user will become idle. |
java.lang.String |
getToken()
Gets the users token. |
java.lang.String |
getUserDisplayName()
Get the user's display name as defined by the 'User Name Display' admin setting. |
java.lang.String |
getUserName()
The name of the user. |
boolean |
hasPrivilege(java.lang.String privilege)
Determines if the user has a given privilege (CM role) or not. |
boolean |
isCrProcessAdmin()
Determines if the user has the CR Process admin role. |
boolean |
isGroupMember(java.lang.String group)
Determines if the user is in a given group. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public User()
public User(com.telelogic.cs.user.UserInfo user)
user
- The UserInfo object to base this User object off of.Method Detail |
---|
public java.lang.String getPrettyRole()
public java.lang.String getRole()
public java.lang.String getUserName()
public java.lang.String getDatabase()
public java.lang.String getContextDatabase()
public java.lang.String getToken()
public java.lang.String getReadSecurityValue()
public boolean getCanAccessApplet()
true
if the user can access the applet, false
otherwise.public java.util.List<java.lang.String> getGroups()
public java.util.List<java.lang.String> getPrivileges()
public boolean isCrProcessAdmin()
true
if the user has the CR process admin role, false
otherwise.public boolean hasPrivilege(java.lang.String privilege)
privilege
- the name of the privilege (CM role) to check for.
true
if the user has the privilege (CM role), false
otherwise.public boolean isGroupMember(java.lang.String group)
group
- the name of the role to check for.
true
if the user has the role, false
otherwise.public java.lang.String getUserDisplayName()
public long getLastAccessedDate()
public long getTimeoutDate()
public java.lang.String getRealName()
getUserDisplayName()
.
public java.lang.String getFormattedLastAccessedDate()
public java.lang.String getFormattedTimeoutDate()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |