IUser (moovapps-process-parent 2024.1.0 API)

All Superinterfaces:

IAttributeSupport, IDeletionSupport, IDirectory, IElement, IExternalSupport, ILocalizationScopeSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable

All Known Subinterfaces:

IOperator
```
public interface IUser
extends IElement, ISecuritySupport, ISearchSupport, IAttributeSupport, IDeletionSupport, IExternalSupport, IProtocolSupport, ILocalizationScopeSupport, IDirectory
```
The IUser interface is part of the VDoc directory.

Since:

1.0

Version:

1.0, 28/10/2007

Author:

Vassyly Lygeros

See Also:

IGroup, ILocalization, IOrganization

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disable()` Allows to disable the account.
`void`	`enable()` Allows to activate the account.
`Date`	`getActivationDate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getActivationDate() instead
`String`	`getAddress1()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getAddress1() instead
`String`	`getAddress2()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getAddress2() instead
`Collection<? extends IGroup>`	`getAllParents()` Gets the user's recursive parents.
`IUser`	`getAssistant()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getAssistant() instead
`IAttachment`	`getAvatar()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getAvatar() instead
`Date`	`getBirthday()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getBirthday() instead
`String`	`getCity()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getCity() instead
`Collection<? extends IUser>`	`getCollaborators()` Gets the user's collaborators.
`String`	`getContractType()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getContractType() instead
`String`	`getCountry()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getCountry() instead
`IUser`	`getCreatedBy()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getCreatedBy() instead
`Date`	`getCreatedDate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getCreatedDate() instead
`String`	`getDescription()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getDescription() instead
`String`	`getEmail()` Gets the user's email.
`String`	`getEmployeeNumber()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getEmployeeNumber() instead
`Date`	`getEntry()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getEntry() instead
`Date`	`getExit()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getExit() instead
`Date`	`getExpiration()` Deprecated. since = 10.0 forRemoval = false use IUser.getTechnicalInformation().getExpirationDate() instead
`Date`	`getExpirationDate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getExpirationDate() instead
`String`	`getFaxNumber()` Gets the user's fax number.
`String`	`getFirstName()` Retrieves the first name of the user.
`String`	`getFullName()` Retrieves the full name of the user.
`IUser`	`getHierarchicalManager()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getHierarchicalManager() instead
`String`	`getLanguage()` Retrieves the user's current language.
`String`	`getLastName()` Retrieves the last name of the user.
`Date`	`getLastPasswordUpdate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getLastPasswordUpdate() instead
`Date`	`getLastVisite()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getLastVisitedDate() method instead
`Date`	`getLastVisitedDate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getLastPasswordUpdate() instead
`Collection<? extends IUser>`	`getLeaders()` Gets the user's leaders.
`ILocalization`	`getLocalization()` Gets the user's localization.
`String`	`getLogin()` Retrieves the login of the user.
`IUser`	`getManager()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getManager() instead
`String`	`getMobilePhoneNumber()` Gets the user's mobile phone number.
`IUser`	`getModifiedBy()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getModifiedBy() instead
`Date`	`getModifiedDate()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().getModifiedDate() instead
`String`	`getNickName()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getNickName() instead
`IOrganization`	`getOrganization()` Retrieves the users's organization.
`Collection<? extends IGroup>`	`getParents()` Gets the user's parents.
`IUserPersonalInformation`	`getPersonalInformation()` Retrieve all the user's personal information
`String`	`getPhoneNumber()` Gets the user's phone number.
`IUserProfessionalInformation`	`getProfessionalInformation()` Retrieve all the user's professional information
`String`	`getSex()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getSex() instead
`String`	`getSignature()` Get the user's signature.
`String`	`getSkin()` Retrieves the user's current skin.
`String`	`getSocialCategory()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getSocialCategory() instead
`String`	`getSub()` Deprecated. since = 2024.1 forRemoval = true use IUser.getTechnicalInformation().getSub() instead
`IUserTechnicalInformation`	`getTechnicalInformation()` Retrieve all the user's technical information
`default String`	`getTimeZone()` Gets the user's time zone.
`String`	`getTitle()` Gets the title of the user.
`String`	`getUserFunction()` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().getUserFunction() instead
`String`	`getZipcode()` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().getZipcode() instead
`boolean`	`isAnonymous()` Checks if the user is the anonymous account
`boolean`	`isConnectionAllowed()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().isConnectionAllowed() instead
`boolean`	`isEnable()` Checks if the account is active.
`boolean`	`isLocked()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().isLocked() instead
`boolean`	`isMemberOf(IGroup group, boolean recursive)` Checks if the user is member of the specified group.
`boolean`	`isMemberOf(ILocalization localization, boolean recursive)` Checks if the user is member of the specified localization.
`boolean`	`isMemberOf(IOrganization organization, boolean recursive)` Checks if the user is member of the specified organization.
`boolean`	`isMemberOf(IProfile profile, boolean recursive)` Checks if the user is member of the specified profile.
`boolean`	`isMemberOf(IRole role, boolean recursive)` Deprecated. use isMemberOf method with `IProfile` parameter instead.
`boolean`	`isSubscriber(IMailingList mailingList)` Tests if the user is a subscriber of a mailing list.
`boolean`	`isSysadmin()` Checks if the user is the sysadmin account
`void`	`setActivationDate(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().setActivationDate() instead
`void`	`setAddress1(String address1)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setAddress1() instead
`void`	`setAddress2(String address2)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setAddress2() instead
`void`	`setAssistant(IUser assistant)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setAssistant() instead
`void`	`setAvatar(IAttachment attachment)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setAvatar() instead
`void`	`setBirthday(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setBirthday() instead
`void`	`setCity(String city)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setCity() instead
`void`	`setContractType(String contractType)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setContractType() instead
`void`	`setCountry(String country)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setCountry() instead
`void`	`setDescription(String description)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setDescription() instead
`void`	`setEmail(String email)` Sets the user's email.
`void`	`setEmployeeNumber(String employeeNumber)` Deprecated. since = 2024.1 forRemoval = false user IUser.getProfessionalInformation().setEmployeeNumber() instead
`void`	`setEntry(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setEntry() instead
`void`	`setExit(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setExit() instead
`void`	`setExpiration(Date date)` Deprecated. since = 10.0 forRemoval = false use IUser.getTechnicalInformation().setExpirationDate() instead
`void`	`setExpirationDate(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().setExpirationDate() instead
`void`	`setFaxNumber(String faxNumber)` Sets the user's fax number.
`void`	`setFirstName(String firstName)` Sets the first name of the user.
`void`	`setFullName(String fullname)` Sets the full name of the user.
`void`	`setHierarchicalManager(IUser hierarchicalManager)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setHierarchicalManager() instead
`void`	`setLanguage(String language)` Sets the user's current language.
`void`	`setLastName(String lastName)` Sets the last name of the user.
`void`	`setLastVisite(Date date)` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().setLastVisitedDate() instead
`void`	`setLocalization(ILocalization localization)` Allows to set the user's localization.
`void`	`setLogin(String login)` Sets the user's login.
`void`	`setManager(IUser manager)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setManager() instead
`void`	`setMobilePhoneNumber(String mobilePhoneNumber)` Sets the user's mobile phone number.
`void`	`setNickName(String nickName)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setNickName() instead
`void`	`setOrganization(IOrganization organization)` Allows to set the user's organization.
`void`	`setPassword(String password)` Sets the user's password.
`void`	`setPhoneNumber(String phoneNumber)` Sets the user's phone number.
`void`	`setSex(String sex)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setSex() instead
`void`	`setSignature(String signature)` Sets the user's signature.
`void`	`setSkin(String skin)` Sets the user's current skin.
`void`	`setSocialCategory(String socialCategory)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setSocialCategory() instead
`default void`	`setTimeZone(String timeZone)` Sets the user's time zone.
`void`	`setTitle(String title)` Sets the title of the user.
`void`	`setUserFunction(String userFunction)` Deprecated. since = 2024.1 forRemoval = false use IUser.getProfessionalInformation().setUserFunction() instead
`void`	`setZipcode(String zipCode)` Deprecated. since = 2024.1 forRemoval = false use IUser.getPersonalInformation().setZipcode() instead
`void`	`unlock()` Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().unlock() instead

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement
getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport
getProtocolURI, getProtocolURI

Methods inherited from interface com.axemble.vdoc.sdk.supports.IAttributeSupport
addAttribute, addAttributes, getAttribute, getAttributes, getExtendedAttributes

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport
delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IExternalSupport
getExternalClassName, getExternalNativeId

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IDirectory
getExternalId, isExternal

- Method Detail
  - isSysadmin
```
boolean isSysadmin()
```
    Checks if the user is the sysadmin account
    
    Returns:
    
    true if the user is the sysadmin account, false otherwise.
  - isAnonymous
```
boolean isAnonymous()
```
    Checks if the user is the anonymous account
    
    Returns:
    
    true if the user is the anonymous account, false otherwise.
  - getLogin
```
String getLogin()
```
    Retrieves the login of the user.
    
    Returns:
    
    A java.lang.String value with the user's login.
  - setLogin
```
void setLogin(String login)
```
    Sets the user's login.
    
    Parameters:
    
    login - A java.lang.String value.
  - getFirstName
```
String getFirstName()
```
    Retrieves the first name of the user.
    
    Returns:
    
    A java.lang.String value with the user's first name.
  - setFirstName
```
void setFirstName(String firstName)
```
    Sets the first name of the user.
    
    Parameters:
    
    firstName - A java.lang.String value.
  - getLastName
```
String getLastName()
```
    Retrieves the last name of the user.
    
    Returns:
    
    A java.lang.String value with the user's last name.
  - setLastName
```
void setLastName(String lastName)
```
    Sets the last name of the user.
    
    Parameters:
    
    lastName - A java.lang.String value.
  - getFullName
```
String getFullName()
```
    Retrieves the full name of the user.
    
    Returns:
    
    A java.lang.String value with the user's full name.
  - setFullName
```
void setFullName(String fullname)
```
    Sets the full name of the user.
    
    Parameters:
    
    fullname - A java.lang.String value.
  - getNickName
```
@Deprecated
String getNickName()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getNickName() instead
    
    Retrieves the nick name of the user.
    
    Returns:
    
    A java.lang.String value.
  - setNickName
```
@Deprecated
void setNickName(String nickName)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setNickName() instead
    
    Sets the nick name of the user.
    
    Parameters:
    
    nickName - A java.lang.String value.
  - getSex
```
@Deprecated
String getSex()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getSex() instead
    
    Retrieves the sex of the user.
    
    Returns:
    
    A java.lang.String value.
  - setSex
```
@Deprecated
void setSex(String sex)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setSex() instead
    
    Sets the sex of the user.
    
    Parameters:
    
    sex - A java.lang.String value.
  - getBirthday
```
@Deprecated
Date getBirthday()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getBirthday() instead
    
    Gets the day of birth of the user.
    
    Returns:
    
    A java.util.Date value.
  - setBirthday
```
@Deprecated
void setBirthday(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setBirthday() instead
    
    Sets the date of birth of the user.
    
    Parameters:
    
    date - A java.util.Date value.
  - getTitle
```
String getTitle()
```
    Gets the title of the user.
    
    Returns:
    
    A java.lang.String value.
  - setTitle
```
void setTitle(String title)
```
    Sets the title of the user.
    
    Parameters:
    
    title - A java.lang.String value.
  - getEmployeeNumber
```
@Deprecated
String getEmployeeNumber()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getEmployeeNumber() instead
    
    Retrieves the user's employee number.
    
    Returns:
    
    A java.lang.String value.
  - setEmployeeNumber
```
@Deprecated
void setEmployeeNumber(String employeeNumber)
```
    Deprecated. since = 2024.1 forRemoval = false
    user IUser.getProfessionalInformation().setEmployeeNumber() instead
    
    Sets the user's employee number.
    
    Parameters:
    
    employeeNumber - A java.lang.String value.
  - getContractType
```
@Deprecated
String getContractType()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getContractType() instead
    
    Retrieves the user's contract type.
    
    Returns:
    
    A java.lang.String value.
  - setContractType
```
@Deprecated
void setContractType(String contractType)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setContractType() instead
    
    Sets the user's contract type.
    
    Parameters:
    
    contractType - A java.lang.String value.
  - getUserFunction
```
@Deprecated
String getUserFunction()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getUserFunction() instead
    
    Retrieves the user's function.
    
    Returns:
    
    A java.lang.String value.
  - setUserFunction
```
@Deprecated
void setUserFunction(String userFunction)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setUserFunction() instead
    
    Sets the user's function.
    
    Parameters:
    
    userFunction - A java.lang.String value.
  - getSocialCategory
```
@Deprecated
String getSocialCategory()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getSocialCategory() instead
    
    Retrieves the user's social category.
    
    Returns:
    
    A java.lang.String value.
  - setSocialCategory
```
@Deprecated
void setSocialCategory(String socialCategory)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setSocialCategory() instead
    
    Sets the user's social category.
    
    Parameters:
    
    socialCategory - A java.lang.String value.
  - getEmail
```
String getEmail()
```
    Gets the user's email.
    
    Returns:
    
    A java.lang.String value.
  - setEmail
```
void setEmail(String email)
```
    Sets the user's email.
    
    Parameters:
    
    email - A java.lang.String value.
  - getFaxNumber
```
String getFaxNumber()
```
    Gets the user's fax number.
    
    Returns:
    
    A java.lang.String value.
  - setFaxNumber
```
void setFaxNumber(String faxNumber)
```
    Sets the user's fax number.
    
    Parameters:
    
    faxNumber - A java.lang.String value.
  - getPhoneNumber
```
String getPhoneNumber()
```
    Gets the user's phone number.
    
    Returns:
    
    A java.lang.String value.
  - setPhoneNumber
```
void setPhoneNumber(String phoneNumber)
```
    Sets the user's phone number.
    
    Parameters:
    
    phoneNumber - A java.lang.String value.
  - getMobilePhoneNumber
```
String getMobilePhoneNumber()
```
    Gets the user's mobile phone number.
    
    Returns:
    
    A java.lang.String value.
  - setMobilePhoneNumber
```
void setMobilePhoneNumber(String mobilePhoneNumber)
```
    Sets the user's mobile phone number.
    
    Parameters:
    
    mobilePhoneNumber - A java.lang.String value.
  - getAvatar
```
@Deprecated
IAttachment getAvatar()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getAvatar() instead
    
    Retrieves the user's avatar as an IAttachment object.
    
    Returns:
    
    An IAttachment object.
  - setAvatar
```
@Deprecated
void setAvatar(IAttachment attachment)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setAvatar() instead
    
    Sets the user's avatar.
    
    Parameters:
    
    attachment - A IAttachment object.
  - getSignature
```
String getSignature()
```
    Get the user's signature.
    
    Returns:
    
    A java.lang.String value.
  - setSignature
```
void setSignature(String signature)
```
    Sets the user's signature.
    
    Parameters:
    
    signature - A java.lang.String value.
  - getSkin
```
String getSkin()
```
    Retrieves the user's current skin.
    
    Returns:
    
    A java.lang.String value.
  - setSkin
```
void setSkin(String skin)
```
    Sets the user's current skin.
    
    Parameters:
    
    skin - A java.lang.String value.
  - getLanguage
```
String getLanguage()
```
    Retrieves the user's current language.
    
    Returns:
    
    A java.lang.String value.
  - setLanguage
```
void setLanguage(String language)
```
    Sets the user's current language.
    
    Parameters:
    
    language - A java.lang.String value.
  - getActivationDate
```
@Deprecated
Date getActivationDate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getActivationDate() instead
    
    Retrieves the account activation date.
    
    Returns:
    
    A java.util.Date value.
  - setActivationDate
```
@Deprecated
void setActivationDate(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().setActivationDate() instead
    
    Sets the account activation date.
    
    Parameters:
    
    date - A java.util.Date value.
  - getLastPasswordUpdate
```
@Deprecated
Date getLastPasswordUpdate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getLastPasswordUpdate() instead
    
    Retrieves the account last password update date.
    
    Returns:
    
    A java.util.Date value.
  - getLastVisite
```
@Deprecated
Date getLastVisite()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getLastVisitedDate() method instead
    
    Returns:
    
    A java.util.Date value.
  - setLastVisite
```
@Deprecated
void setLastVisite(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().setLastVisitedDate() instead
    
    Sets the user's last connection.
    
    Parameters:
    
    date - A java.util.Date value.
  - getLastVisitedDate
```
@Deprecated
Date getLastVisitedDate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getLastPasswordUpdate() instead
    
    Retrieves the account last visited date.
    
    Returns:
    
    A java.util.Date value.
  - getEntry
```
@Deprecated
Date getEntry()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getEntry() instead
    
    Gets the entry date in the organization.
    
    Returns:
    
    A java.util.Date value.
  - setEntry
```
@Deprecated
void setEntry(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setEntry() instead
    
    Sets the date of entry of the user in the organization.
    
    Parameters:
    
    date - A java.util.Date value.
  - getExit
```
@Deprecated
Date getExit()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getExit() instead
    
    Gets the leaving date from the organization.
    
    Returns:
    
    A java.util.Date value.
  - setExit
```
@Deprecated
void setExit(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setExit() instead
    
    Sets the leaving date of the user from the organization.
    
    Parameters:
    
    date - A java.util.Date value.
  - getExpiration
```
@Deprecated
Date getExpiration()
```
    Deprecated. since = 10.0 forRemoval = false
    use IUser.getTechnicalInformation().getExpirationDate() instead
    
    Returns:
    
    A java.util.Date value.
  - setExpiration
```
@Deprecated
void setExpiration(Date date)
```
    Deprecated. since = 10.0 forRemoval = false
    use IUser.getTechnicalInformation().setExpirationDate() instead
    
    Parameters:
    
    date - A java.util.Date value.
  - getExpirationDate
```
@Deprecated
Date getExpirationDate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getExpirationDate() instead
    
    Retrieves the expiration date.
    
    Returns:
    
    A java.util.Date value.
  - setExpirationDate
```
@Deprecated
void setExpirationDate(Date date)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().setExpirationDate() instead
    
    Sets the account expiration date.
    
    Parameters:
    
    date - A java.util.Date value.
  - getAddress1
```
@Deprecated
String getAddress1()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getAddress1() instead
    
    Gets the user's first address text.
    
    Returns:
    
    A java.lang.String value.
  - setAddress1
```
@Deprecated
void setAddress1(String address1)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setAddress1() instead
    
    Sets the first address text.
    
    Parameters:
    
    address1 - A java.lang.String value.
  - getAddress2
```
@Deprecated
String getAddress2()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getAddress2() instead
    
    Gets the user's second address text.
    
    Returns:
    
    A java.lang.String value.
  - setAddress2
```
@Deprecated
void setAddress2(String address2)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setAddress2() instead
    
    Sets the second address text.
    
    Parameters:
    
    address2 - A java.lang.String value.
  - getCity
```
@Deprecated
String getCity()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getCity() instead
    
    Gets the user's city.
    
    Returns:
    
    A java.lang.String value.
  - setCity
```
@Deprecated
void setCity(String city)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setCity() instead
    
    Sets the user's address city.
    
    Parameters:
    
    city - A java.lang.String value.
  - getZipcode
```
@Deprecated
String getZipcode()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getZipcode() instead
    
    Gets the user's ZIP code.
    
    Returns:
    
    A java.lang.String value.
  - setZipcode
```
@Deprecated
void setZipcode(String zipCode)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setZipcode() instead
    
    Sets the user's address ZIP code
    
    Parameters:
    
    zipCode - A java.lang.String value.
  - getCountry
```
@Deprecated
String getCountry()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getCountry() instead
    
    Gets the user's country.
    
    Returns:
    
    A java.lang.String value.
  - setCountry
```
@Deprecated
void setCountry(String country)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setCountry() instead
    
    Sets the user's address country
    
    Parameters:
    
    country - A java.lang.String value.
  - getCreatedDate
```
@Deprecated
Date getCreatedDate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getCreatedDate() instead
    
    Gets the created date.
    
    Returns:
    
    A java.util.Date value.
  - getCreatedBy
```
@Deprecated
IUser getCreatedBy()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getCreatedBy() instead
    
    Gets the creator of the user.
    
    Returns:
    
    A IUser object.
  - getModifiedDate
```
@Deprecated
Date getModifiedDate()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getModifiedDate() instead
    
    Gets the modified date.
    
    Returns:
    
    A java.util.Date value.
  - getModifiedBy
```
@Deprecated
IUser getModifiedBy()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getTechnicalInformation().getModifiedBy() instead
    
    Gets the editor of the user.
    
    Returns:
    
    A IUser object.
  - getDescription
```
@Deprecated
String getDescription()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().getDescription() instead
    
    Gets the description of the user.
    
    Returns:
    
    A String value.
  - setDescription
```
@Deprecated
void setDescription(String description)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getPersonalInformation().setDescription() instead
    
    Sets the description of the user.
    
    Parameters:
    
    description - The new description to set the user with.
  - getAssistant
```
@Deprecated
IUser getAssistant()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getAssistant() instead
    
    Retrieves the user's assistant.
    
    Returns:
    
    A IUser object.
  - setAssistant
```
@Deprecated
void setAssistant(IUser assistant)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setAssistant() instead
    
    Sets the user's assistant.
    
    Parameters:
    
    assistant - A IUser object.
  - getManager
```
@Deprecated
IUser getManager()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getManager() instead
    
    Retrieves the user's manager.
    
    Returns:
    
    A IUser object.
  - setManager
```
@Deprecated
void setManager(IUser manager)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setManager() instead
    
    Sets the user's manager.
    
    Parameters:
    
    manager - A IUser object.
  - getHierarchicalManager
```
@Deprecated
IUser getHierarchicalManager()
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().getHierarchicalManager() instead
    
    Retrieves the user's hierarchical manager.
    
    Returns:
    
    A IUser object.
  - setHierarchicalManager
```
@Deprecated
void setHierarchicalManager(IUser hierarchicalManager)
```
    Deprecated. since = 2024.1 forRemoval = false
    use IUser.getProfessionalInformation().setHierarchicalManager() instead
    
    Sets the user's hierarchical manager.
    
    Parameters:
    
    hierarchicalManager - A IUser object.
  - getCollaborators
```
Collection<? extends IUser> getCollaborators()
```
    Gets the user's collaborators.
    
    Returns:
    
    A java.util.Collection of IUser object.
  - getLeaders
```
Collection<? extends IUser> getLeaders()
```
    Gets the user's leaders.
    
    Returns:
    
    A java.util.Collection of IUser object.
  - getOrganization
```
IOrganization getOrganization()
```
    Retrieves the users's organization.
    
    Returns:
    
    A IOrganization object.
  - setOrganization
```
void setOrganization(IOrganization organization)
```
    Allows to set the user's organization.
    
    Parameters:
    
    organization - A IOrganization object.
  - getLocalization
```
ILocalization getLocalization()
```
    Gets the user's localization.
    
    Returns:
    
    A ILocalization object.
  - setLocalization
```
void setLocalization(ILocalization localization)
```
    Allows to set the user's localization.
    
    Parameters:
    
    localization - A ILocalization object.
  - isMemberOf
```
boolean isMemberOf(IGroup group,
                   boolean recursive)
```
    Checks if the user is member of the specified group.
    
    Parameters:
    
    group - A IGroup object.
    
    recursive - Set to true if you wish to check recursively, false otherwise.
    
    Returns:
    
    true if the user is member of the group, false otherwise.
  - isMemberOf
```
@Deprecated
boolean isMemberOf(IRole role,
                               boolean recursive)
```
    Deprecated. use isMemberOf method with IProfile parameter instead.
    
    Parameters:
    
    role - A IRole object.
    
    recursive - Set to true if you wish to check recursively, false otherwise.
    
    Returns:
    
    true if the user is member of the role, false otherwise.
  - isMemberOf
```
boolean isMemberOf(IProfile profile,
                   boolean recursive)
```
    Checks if the user is member of the specified profile.
    
    Parameters:
    
    profile - A IProfile object.
    
    recursive - Set to true if you wish to check recursively, false otherwise.
    
    Returns:
    
    true if the user is member of the profile, false otherwise.
  - isMemberOf
```
boolean isMemberOf(IOrganization organization,
                   boolean recursive)
```
    Checks if the user is member of the specified organization.
    
    Parameters:
    
    organization - A IOrganization object.
    
    recursive - Set to true if you wish to check recursively, false otherwise.
    
    Returns:
    
    true if the user is member of the organization, false otherwise.
  - isMemberOf
```
boolean isMemberOf(ILocalization localization,
                   boolean recursive)
```
    Checks if the user is member of the specified localization.
    
    Parameters:
    
    localization - A ILocalization object.
    
    recursive - Set to true if you wish to check recursively, false otherwise.
    
    Returns:
    
    true if the user is member of the localization, false otherwise.
  - isSubscriber
```
boolean isSubscriber(IMailingList mailingList)
```
    Tests if the user is a subscriber of a mailing list. Returns true if user is a subscriber of the mailing list, false otherwise.
    Parameters: mailingList - IMailingList the mailing list. Returns: true if user is a subscriber of the mailing list, false otherwise.
  getParents Collection<? extends IGroup> getParents() Gets the user's parents. Returns: A java.util.Collection of IGroup object. getAllParents Collection<? extends IGroup> getAllParents() Gets the user's recursive parents. Returns: A java.util.Collection of IGroup object. setPassword void setPassword(String password) Sets the user's password. Parameters: password - A java.lang.String value. isEnable boolean isEnable() Checks if the account is active. Returns: true if the account is active, false otherwise. enable void enable() Allows to activate the account. disable void disable() Allows to disable the account. isConnectionAllowed @Deprecated boolean isConnectionAllowed() Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().isConnectionAllowed() instead Checks if the user can open a connection. Returns: true if the user can open a connection, false otherwise. isLocked @Deprecated boolean isLocked() Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().isLocked() instead Checks if the user is locked. Returns: true if the user is locked, false otherwise. unlock @Deprecated void unlock() Deprecated. since = 2024.1 forRemoval = false use IUser.getTechnicalInformation().unlock() instead Allows to unlock the user. getTimeZone default String getTimeZone() Gets the user's time zone. setTimeZone default void setTimeZone(String timeZone) Sets the user's time zone. getSub @Deprecated String getSub() Deprecated. since = 2024.1 forRemoval = true use IUser.getTechnicalInformation().getSub() instead Retrieves the user's sub. Returns: A java.lang.String value. getProfessionalInformation IUserProfessionalInformation getProfessionalInformation() Retrieve all the user's professional information Returns: the user's professional information getPersonalInformation IUserPersonalInformation getPersonalInformation() Retrieve all the user's personal information Returns: the user's personal information getTechnicalInformation IUserTechnicalInformation getTechnicalInformation() Retrieve all the user's technical information Returns: the user's technical information

Interface IUser

Method Summary

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

Methods inherited from interface com.axemble.vdoc.sdk.supports.IAttributeSupport

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

Methods inherited from interface com.axemble.vdoc.sdk.supports.IExternalSupport

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IDirectory

Method Detail

isSysadmin

isAnonymous

getLogin

setLogin

getFirstName

setFirstName

getLastName

setLastName

getFullName

setFullName

getNickName

setNickName

getSex

setSex

getBirthday

setBirthday

getTitle

setTitle

getEmployeeNumber

setEmployeeNumber

getContractType

setContractType

getUserFunction

setUserFunction

getSocialCategory

setSocialCategory

getEmail

setEmail

getFaxNumber

setFaxNumber

getPhoneNumber

setPhoneNumber

getMobilePhoneNumber

setMobilePhoneNumber

getAvatar

setAvatar

getSignature

setSignature

getSkin

setSkin

getLanguage

setLanguage

getActivationDate

setActivationDate

getLastPasswordUpdate

getLastVisite

setLastVisite

getLastVisitedDate

getEntry

setEntry

getExit

setExit

getExpiration

setExpiration

getExpirationDate

setExpirationDate

getAddress1

setAddress1

getAddress2

setAddress2

getCity

setCity

getZipcode

setZipcode

getCountry

setCountry

getCreatedDate

getCreatedBy

getModifiedDate

getModifiedBy

getDescription