com.ibm.pim.organization
Interface User

All Superinterfaces:
Performer

public interface User
extends Performer

Interface for the User object.

Since:
6.0.0

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

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getAddress

java.lang.String getAddress()
Retrieves the User's address

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getCompany

Company getCompany()
Returns the company associated with this User.

Returns:
A Company object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getEmail

java.lang.String getEmail()
Retrieves the User's email address

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

isEnabled

boolean isEnabled()
Identifies if the user is enabled(active) or not

Returns:
true if enabled otherwise false
Throws:
PIMInternalException - If an internal error occurs

getFax

java.lang.String getFax()
Retrieves the User's facsimile number

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getFirstName

java.lang.String getFirstName()
Retrieves the User's first name

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getLastName

java.lang.String getLastName()
Retrieves the User's last name

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

isLdapEnabled

boolean isLdapEnabled()
Identifies if the user is an LDAP registered user or not

Returns:
true if LDAP registered otherwise false
Throws:
PIMInternalException - If an internal error occurs

getLdapEntryDn

java.lang.String getLdapEntryDn()
Retrieves the LDAP Distinguished name if assigned to this user

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getLdapServerUrl

java.lang.String getLdapServerUrl()
Retrieves the LDAP Server URL used to authenticate this user

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getUserName

java.lang.String getUserName()
Retrieves the User's name

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getOrganizations

java.util.Collection<Organization> getOrganizations()
Retrieves the Organizations the user belongs to.

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getPhone

java.lang.String getPhone()
Retrieves the User's phone number

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getRoles

PIMCollection<Role> getRoles()
Retrieves the Role objects this User is registered to

Returns:
Collection of Roles
Throws:
PIMInternalException - If an internal error occurs

getTitle

java.lang.String getTitle()
Retrieves the User's title

Returns:
The string value
Throws:
PIMInternalException - If an internal error occurs

getUserSettingValue

java.lang.String getUserSettingValue(UserSetting setting)
Fetches the value of a user setting as a String

Parameters:
setting - The UserSetting for which the value has to be fetched
Returns:
The UserSetting value
Throws:
PIMInternalException - If an internal error occurs

save

void save()
Saves this User information

Throws:
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

setAddress

void setAddress(java.lang.String address)
Sets the User's address

Parameters:
address - The string value
Throws:
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

setEmail

void setEmail(java.lang.String email)
Sets the User's email address

Parameters:
email - The string value
Throws:
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.

setFax

void setFax(java.lang.String fax)
Sets the User's facsimile number

Parameters:
fax - The string value
Throws:
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

setFirstName

void setFirstName(java.lang.String name)
Sets the User's first name

Parameters:
name - The string value
Throws:
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.

setLastName

void setLastName(java.lang.String name)
Sets the User's last name

Parameters:
name - The string value
Throws:
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.

setEnabled

void setEnabled(boolean enabled)
Sets the User to enabled or not i.e. active MDMPIM user or not

Parameters:
enabled - true for enabled false for disabled
Throws:
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

setLdapEnabled

void setLdapEnabled(boolean enabled)
Specifies if the User is an LDAP user or not

Parameters:
enabled - true for LDAP enabled false for traditional MDMPIM
Throws:
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

setLdapEntryDn

void setLdapEntryDn(java.lang.String dn)
Sets the Distinguished name for an LDAP User

Parameters:
dn - The string value
Throws:
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

setLdapServerUrl

void setLdapServerUrl(java.lang.String server)
Sets the URL of the LDAP server the User is authenticated against

Parameters:
server - The string value
Throws:
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

setUserName

void setUserName(java.lang.String name)
Sets the Username

Parameters:
name - The string value
Throws:
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.

setPhone

void setPhone(java.lang.String phone)
Sets the User's phone number

Parameters:
phone - The string value
Throws:
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

setRoles

void setRoles(java.util.List<Role> roles)
Sets the Roles applicable to this User

Parameters:
roles - A Collection of Role objects
Throws:
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.

setTitle

void setTitle(java.lang.String title)
Sets the User's title

Parameters:
title - The string value
Throws:
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

setPassword

void setPassword(java.lang.String password)
Sets the User's password

Parameters:
password - The password
Throws:
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.

setUserSettingValue

void setUserSettingValue(UserSetting setting,
                         java.lang.String value)
Sets the value for a user setting

Parameters:
setting - The UserSetting for which the value has to be set
value - Value for the UserSetting
Throws:
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.