|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface User
Interface for the User object.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
java.lang.String |
getAddress()
Retrieves the User's address |
Company |
getCompany()
Returns the company associated with this User. |
java.lang.String |
getEmail()
Retrieves the User's email address |
java.lang.String |
getFax()
Retrieves the User's facsimile number |
java.lang.String |
getFirstName()
Retrieves the User's first name |
java.lang.String |
getLastName()
Retrieves the User's last name |
java.lang.String |
getLdapEntryDn()
Retrieves the LDAP Distinguished name if assigned to this user |
java.lang.String |
getLdapServerUrl()
Retrieves the LDAP Server URL used to authenticate this user |
java.util.Collection<Organization> |
getOrganizations()
Retrieves the Organizations the user belongs to. |
java.lang.String |
getPhone()
Retrieves the User's phone number |
PIMCollection<Role> |
getRoles()
Retrieves the Role objects this User is registered to |
java.lang.String |
getTitle()
Retrieves the User's title |
java.lang.String |
getUserName()
Retrieves the User's name |
java.lang.String |
getUserSettingValue(UserSetting setting)
Fetches the value of a user setting as a String |
boolean |
isEnabled()
Identifies if the user is enabled(active) or not |
boolean |
isLdapEnabled()
Identifies if the user is an LDAP registered user or not |
void |
save()
Saves this User information |
void |
setAddress(java.lang.String address)
Sets the User's address |
void |
setEmail(java.lang.String email)
Sets the User's email address |
void |
setEnabled(boolean enabled)
Sets the User to enabled or not i.e. |
void |
setFax(java.lang.String fax)
Sets the User's facsimile number |
void |
setFirstName(java.lang.String name)
Sets the User's first name |
void |
setLastName(java.lang.String name)
Sets the User's last name |
void |
setLdapEnabled(boolean enabled)
Specifies if the User is an LDAP user or not |
void |
setLdapEntryDn(java.lang.String dn)
Sets the Distinguished name for an LDAP User |
void |
setLdapServerUrl(java.lang.String server)
Sets the URL of the LDAP server the User is authenticated against |
void |
setPassword(java.lang.String password)
Sets the User's password |
void |
setPhone(java.lang.String phone)
Sets the User's phone number |
void |
setRoles(java.util.List<Role> roles)
Sets the Roles applicable to this User |
void |
setTitle(java.lang.String title)
Sets the User's title |
void |
setUserName(java.lang.String name)
Sets the Username |
void |
setUserSettingValue(UserSetting setting,
java.lang.String value)
Sets the value for a user setting |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getAddress()
PIMInternalException
- If an internal error occursCompany getCompany()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.lang.String getEmail()
PIMInternalException
- If an internal error occursboolean isEnabled()
PIMInternalException
- If an internal error occursjava.lang.String getFax()
PIMInternalException
- If an internal error occursjava.lang.String getFirstName()
PIMInternalException
- If an internal error occursjava.lang.String getLastName()
PIMInternalException
- If an internal error occursboolean isLdapEnabled()
PIMInternalException
- If an internal error occursjava.lang.String getLdapEntryDn()
PIMInternalException
- If an internal error occursjava.lang.String getLdapServerUrl()
PIMInternalException
- If an internal error occursjava.lang.String getUserName()
PIMInternalException
- If an internal error occursjava.util.Collection<Organization> getOrganizations()
PIMInternalException
- If an internal error occursjava.lang.String getPhone()
PIMInternalException
- If an internal error occursPIMCollection<Role> getRoles()
PIMInternalException
- If an internal error occursjava.lang.String getTitle()
PIMInternalException
- If an internal error occursjava.lang.String getUserSettingValue(UserSetting setting)
setting
- The UserSetting for which the value has to be fetched
PIMInternalException
- If an internal error occursvoid save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setAddress(java.lang.String address)
address
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setEmail(java.lang.String email)
email
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or empty.void setFax(java.lang.String fax)
fax
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setFirstName(java.lang.String name)
name
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or empty.void setLastName(java.lang.String name)
name
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or empty.void setEnabled(boolean enabled)
enabled
- true for enabled false for disabled
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setLdapEnabled(boolean enabled)
enabled
- true for LDAP enabled false for traditional MDMPIM
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setLdapEntryDn(java.lang.String dn)
dn
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setLdapServerUrl(java.lang.String server)
server
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setUserName(java.lang.String name)
name
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or empty.void setPhone(java.lang.String phone)
phone
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setRoles(java.util.List<Role> roles)
roles
- A Collection of Role objects
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.lang.IllegalArgumentException
- If any of the input parameters is null.void setTitle(java.lang.String title)
title
- The string value
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
void setPassword(java.lang.String password)
password
- The password
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or empty.void setUserSettingValue(UserSetting setting, java.lang.String value)
setting
- The UserSetting for which the value has to be setvalue
- Value for the UserSetting
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters in null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |