Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqUserInfo

All Known Subinterfaces:
CqUser

public interface CqUserInfo

Read-only information about the currently logged-in user of a user database


Method Summary
 CqUser.AuthenticationMode getAuthenticationMode()
           
 String getAuthenticator()
           
 String getEmail()
           
 String getFullName()
           
 String[] getGroupNames()
           
 String getLoginName()
           
 String getMiscellaneousInformation()
           
 String getPhone()
           
 

Method Detail

getAuthenticationMode

CqUser.AuthenticationMode getAuthenticationMode()
                                                throws WvcmException
Returns:
An AuthenticationMode enumerator indicating what method is used to authenticate this user. Will never be null.
Throws:
WvcmException

getAuthenticator

String getAuthenticator()
                        throws WvcmException
Returns:
A String containing an encrypted copy of the user password or LDAP name. Will never be null.
Throws:
WvcmException

getEmail

String getEmail()
                throws WvcmException
Returns:
A String containing the email field of this user's profile. Will never be null.
Throws:
WvcmException

getFullName

String getFullName()
                   throws WvcmException
Returns:
A String containing the full name field of this user's profile. Will never be null.
Throws:
WvcmException

getGroupNames

String[] getGroupNames()
                       throws WvcmException
Returns:
A String[] containing the name for each group this user belongs to. Will never be null.
Throws:
WvcmException

getLoginName

String getLoginName()
                    throws WvcmException
Returns:
A String containing the login name field of the user's profile. Will never be null.
Throws:
WvcmException

getMiscellaneousInformation

String getMiscellaneousInformation()
                                   throws WvcmException
Returns:
A String containing the content of the miscellaneous information field of this user's profile. Will never be null.
Throws:
WvcmException

getPhone

String getPhone()
                throws WvcmException
Returns:
A String containing the phone field of this user's profile. Will never be null.
Throws:
WvcmException

Generated Fri 30-Jul-2010 12:52 AM

Copyright © IBM 2010. All rights reserved.