IUser (moovapps-process-parent 17.2.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()` Retrieves the account activation date.
`String`	`getAddress1()` Gets the user's first address text.
`String`	`getAddress2()` Gets the user's second address text.
`Collection<? extends IGroup>`	`getAllParents()` Gets the user's recursive parents.
`IUser`	`getAssistant()` Retrieves the user's assistant.
`IAttachment`	`getAvatar()` Retrieves the user's avatar as an `IAttachment` object.
`Date`	`getBirthday()` Gets the day of birth of the user.
`String`	`getCity()` Gets the user's city.
`Collection<? extends IUser>`	`getCollaborators()` Gets the user's collaborators.
`String`	`getContractType()` Retrieves the user's contract type.
`String`	`getCountry()` Gets the user's country.
`IUser`	`getCreatedBy()` Gets the creator of the user.
`Date`	`getCreatedDate()` Gets the created date.
`String`	`getDescription()` Gets the description of the user.
`String`	`getEmail()` Gets the user's email.
`String`	`getEmployeeNumber()` Retrieves the user's employee number.
`Date`	`getEntry()` Gets the entry date in the organization.
`Date`	`getExit()` Gets the leaving date from the organization.
`Date`	`getExpiration()` Deprecated. use getExpirationDate method instead
`Date`	`getExpirationDate()` Retrieves the expiration date.
`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()` Retrieves the user's hierarchical manager.
`String`	`getLanguage()` Retrieves the user's current language.
`String`	`getLastName()` Retrieves the last name of the user.
`Date`	`getLastPasswordUpdate()` Retrieves the account last password update date.
`Date`	`getLastVisite()` Deprecated. use getLastVisitedDate method instead
`Date`	`getLastVisitedDate()` Retrieves the account last visited date.
`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()` Retrieves the user's manager.
`String`	`getMobilePhoneNumber()` Gets the user's mobile phone number.
`IUser`	`getModifiedBy()` Gets the editor of the user.
`Date`	`getModifiedDate()` Gets the modified date.
`String`	`getNickName()` Retrieves the nick name of the user.
`IOrganization`	`getOrganization()` Retrieves the users's organization.
`Collection<? extends IGroup>`	`getParents()` Gets the user's parents.
`String`	`getPhoneNumber()` Gets the user's phone number.
`String`	`getSex()` Retrieves the sex of the user.
`String`	`getSignature()` Get the user's signature.
`String`	`getSkin()` Retrieves the user's current skin.
`String`	`getSocialCategory()` Retrieves the user's social category.
`default String`	`getTimeZone()` Gets the user's time zone.
`String`	`getTitle()` Gets the title of the user.
`String`	`getUserFunction()` Retrieves the user's function.
`String`	`getZipcode()` Gets the user's ZIP code.
`boolean`	`isAnonymous()` Checks if the user is the anonymous account
`boolean`	`isConnectionAllowed()` Checks if the user can open a connection.
`boolean`	`isEnable()` Checks if the account is active.
`boolean`	`isLocked()` Checks if the user is locked.
`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)` Sets the account activation date.
`void`	`setAddress1(String address1)` Sets the first address text.
`void`	`setAddress2(String address2)` Sets the second address text.
`void`	`setAssistant(IUser assistant)` Sets the user's assistant.
`void`	`setAvatar(IAttachment attachment)` Sets the user's avatar.
`void`	`setBirthday(Date date)` Sets the date of birth of the user.
`void`	`setCity(String city)` Sets the user's address city.
`void`	`setContractType(String contractType)` Sets the user's contract type.
`void`	`setCountry(String country)` Sets the user's address country
`void`	`setDescription(String description)` Sets the description of the user.
`void`	`setEmail(String email)` Sets the user's email.
`void`	`setEmployeeNumber(String employeeNumber)` Sets the user's employee number.
`void`	`setEntry(Date date)` Sets the date of entry of the user in the organization.
`void`	`setExit(Date date)` Sets the leaving date of the user from the organization.
`void`	`setExpiration(Date date)` Deprecated. use setExpirationDate method instead
`void`	`setExpirationDate(Date date)` Sets the account expiration date.
`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)` Sets the user's hierarchical manager.
`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)` Sets the user's last connection.
`void`	`setLocalization(ILocalization localization)` Allows to set the user's localization.
`void`	`setLogin(String login)` Sets the user's login.
`void`	`setManager(IUser manager)` Sets the user's manager.
`void`	`setMobilePhoneNumber(String mobilePhoneNumber)` Sets the user's mobile phone number.
`void`	`setNickName(String nickName)` Sets the nick name of the user.
`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)` Sets the sex of the user.
`void`	`setSignature(String signature)` Sets the user's signature.
`void`	`setSkin(String skin)` Sets the user's current skin.
`void`	`setSocialCategory(String socialCategory)` Sets the user's social category.
`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)` Sets the user's function.
`void`	`setZipcode(String zipCode)` Sets the user's address ZIP code
`void`	`unlock()` Allows to unlock the user.

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.
  - getFirstName
```
String getFirstName()
```
    Retrieves the first name of the user.
    
    Returns:
    
    A java.lang.String value with the user's first name.
  - getLastName
```
String getLastName()
```
    Retrieves the last name of the user.
    
    Returns:
    
    A java.lang.String value with the user's last name.
  - getFullName
```
String getFullName()
```
    Retrieves the full name of the user.
    
    Returns:
    
    A java.lang.String value with the user's full name.
  - getNickName
```
String getNickName()
```
    Retrieves the nick name of the user.
    
    Returns:
    
    A java.lang.String value.
  - getSex
```
String getSex()
```
    Retrieves the sex of the user.
    
    Returns:
    
    A java.lang.String value.
  - getBirthday
```
Date getBirthday()
```
    Gets the day of birth of the user.
    
    Returns:
    
    A java.util.Date value.
  - getTitle
```
String getTitle()
```
    Gets the title of the user.
    
    Returns:
    
    A java.lang.String value.
  - getEmployeeNumber
```
String getEmployeeNumber()
```
    Retrieves the user's employee number.
    
    Returns:
    
    A java.lang.String value.
  - getContractType
```
String getContractType()
```
    Retrieves the user's contract type.
    
    Returns:
    
    A java.lang.String value.
  - getUserFunction
```
String getUserFunction()
```
    Retrieves the user's function.
    
    Returns:
    
    A java.lang.String value.
  - getSocialCategory
```
String getSocialCategory()
```
    Retrieves the user's social category.
    
    Returns:
    
    A java.lang.String value.
  - getEmail
```
String getEmail()
```
    Gets the user's email.
    
    Returns:
    
    A java.lang.String value.
  - getFaxNumber
```
String getFaxNumber()
```
    Gets the user's fax number.
    
    Returns:
    
    A java.lang.String value.
  - getPhoneNumber
```
String getPhoneNumber()
```
    Gets the user's phone number.
    
    Returns:
    
    A java.lang.String value.
  - getMobilePhoneNumber
```
String getMobilePhoneNumber()
```
    Gets the user's mobile phone number.
    
    Returns:
    
    A java.lang.String value.
  - getAvatar
```
IAttachment getAvatar()
```
    Retrieves the user's avatar as an IAttachment object.
    
    Returns:
    
    An IAttachment object.
  - getSignature
```
String getSignature()
```
    Get the user's signature.
    
    Returns:
    
    A java.lang.String value.
  - getSkin
```
String getSkin()
```
    Retrieves the user's current skin.
    
    Returns:
    
    A java.lang.String value.
  - getLanguage
```
String getLanguage()
```
    Retrieves the user's current language.
    
    Returns:
    
    A java.lang.String value.
  - getActivationDate
```
Date getActivationDate()
```
    Retrieves the account activation date.
    
    Returns:
    
    A java.util.Date value.
  - getLastPasswordUpdate
```
Date getLastPasswordUpdate()
```
    Retrieves the account last password update date.
    
    Returns:
    
    A java.util.Date value.
  - getLastVisite
```
@Deprecated
Date getLastVisite()
```
    Deprecated. use getLastVisitedDate method instead
    
    Returns:
    
    A java.util.Date value.
  - getLastVisitedDate
```
Date getLastVisitedDate()
```
    Retrieves the account last visited date.
    
    Returns:
    
    A java.util.Date value.
  - getEntry
```
Date getEntry()
```
    Gets the entry date in the organization.
    
    Returns:
    
    A java.util.Date value.
  - getExit
```
Date getExit()
```
    Gets the leaving date from the organization.
    
    Returns:
    
    A java.util.Date value.
  - getExpiration
```
@Deprecated
Date getExpiration()
```
    Deprecated. use getExpirationDate method instead
    
    Returns:
    
    A java.util.Date value.
  - getExpirationDate
```
Date getExpirationDate()
```
    Retrieves the expiration date.
    
    Returns:
    
    A java.util.Date value.
  - getAddress1
```
String getAddress1()
```
    Gets the user's first address text.
    
    Returns:
    
    A java.lang.String value.
  - getAddress2
```
String getAddress2()
```
    Gets the user's second address text.
    
    Returns:
    
    A java.lang.String value.
  - getCity
```
String getCity()
```
    Gets the user's city.
    
    Returns:
    
    A java.lang.String value.
  - getZipcode
```
String getZipcode()
```
    Gets the user's ZIP code.
    
    Returns:
    
    A java.lang.String value.
  - getCountry
```
String getCountry()
```
    Gets the user's country.
    
    Returns:
    
    A java.lang.String value.
  - getCreatedDate
```
Date getCreatedDate()
```
    Gets the created date.
    
    Returns:
    
    A java.util.Date value.
  - getCreatedBy
```
IUser getCreatedBy()
```
    Gets the creator of the user.
    
    Returns:
    
    A IUser object.
  - getModifiedDate
```
Date getModifiedDate()
```
    Gets the modified date.
    
    Returns:
    
    A java.util.Date value.
  - getModifiedBy
```
IUser getModifiedBy()
```
    Gets the editor of the user.
    
    Returns:
    
    A IUser object.
  - getDescription
```
String getDescription()
```
    Gets the description of the user.
    
    Returns:
    
    A String value.
  - getAssistant
```
IUser getAssistant()
```
    Retrieves the user's assistant.
    
    Returns:
    
    A IUser object.
  - getManager
```
IUser getManager()
```
    Retrieves the user's manager.
    
    Returns:
    
    A IUser object.
  - getHierarchicalManager
```
IUser getHierarchicalManager()
```
    Retrieves the user's hierarchical manager.
    
    Returns:
    
    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. setLogin void setLogin(String login) Sets the user's login. Parameters: login - A java.lang.String value. setPassword void setPassword(String password) Sets the user's password. Parameters: password - A java.lang.String value. setFirstName void setFirstName(String firstName) Sets the first name of the user. Parameters: firstName - A java.lang.String value. setLastName void setLastName(String lastName) Sets the last name of the user. Parameters: lastName - A java.lang.String value. setFullName void setFullName(String fullname) Sets the full name of the user. Parameters: fullname - A java.lang.String value. setNickName void setNickName(String nickName) Sets the nick name of the user. Parameters: nickName - A java.lang.String value. setSex void setSex(String sex) Sets the sex of the user. Parameters: sex - A java.lang.String value. setBirthday void setBirthday(Date date) Sets the date of birth of the user. Parameters: date - A java.util.Date value. setTitle void setTitle(String title) Sets the title of the user. Parameters: title - A java.lang.String value. setEmployeeNumber void setEmployeeNumber(String employeeNumber) Sets the user's employee number. Parameters: employeeNumber - A java.lang.String value. setContractType void setContractType(String contractType) Sets the user's contract type. Parameters: contractType - A java.lang.String value. setUserFunction void setUserFunction(String userFunction) Sets the user's function. Parameters: userFunction - A java.lang.String value. setSocialCategory void setSocialCategory(String socialCategory) Sets the user's social category. Parameters: socialCategory - A java.lang.String value. setEmail void setEmail(String email) Sets the user's email. Parameters: email - A java.lang.String value. setFaxNumber void setFaxNumber(String faxNumber) Sets the user's fax number. Parameters: faxNumber - A java.lang.String value. setPhoneNumber void setPhoneNumber(String phoneNumber) Sets the user's phone number. Parameters: phoneNumber - A java.lang.String value. setMobilePhoneNumber void setMobilePhoneNumber(String mobilePhoneNumber) Sets the user's mobile phone number. Parameters: mobilePhoneNumber - A java.lang.String value. setAvatar void setAvatar(IAttachment attachment) Sets the user's avatar. Parameters: attachment - A IAttachment object. setSignature void setSignature(String signature) Sets the user's signature. Parameters: signature - A java.lang.String value. setSkin void setSkin(String skin) Sets the user's current skin. Parameters: skin - A java.lang.String value. setLanguage void setLanguage(String language) Sets the user's current language. Parameters: language - A java.lang.String value. setLastVisite void setLastVisite(Date date) Sets the user's last connection. Parameters: date - A java.util.Date value. setEntry void setEntry(Date date) Sets the date of entry of the user in the organization. Parameters: date - A java.util.Date value. setExit void setExit(Date date) Sets the leaving date of the user from the organization. Parameters: date - A java.util.Date value. setActivationDate void setActivationDate(Date date) Sets the account activation date. Parameters: date - A java.util.Date value. setExpiration @Deprecated void setExpiration(Date date) Deprecated. use setExpirationDate method instead Parameters: date - A java.util.Date value. setExpirationDate void setExpirationDate(Date date) Sets the account expiration date. Parameters: date - A java.util.Date value. setAddress1 void setAddress1(String address1) Sets the first address text. Parameters: address1 - A java.lang.String value. setAddress2 void setAddress2(String address2) Sets the second address text. Parameters: address2 - A java.lang.String value. setCity void setCity(String city) Sets the user's address city. Parameters: city - A java.lang.String value. setZipcode void setZipcode(String zipCode) Sets the user's address ZIP code Parameters: zipCode - A java.lang.String value. setCountry void setCountry(String country) Sets the user's address country Parameters: country - A java.lang.String value. setDescription void setDescription(String description) Sets the description of the user. Parameters: description - The new description to set the user with. setAssistant void setAssistant(IUser assistant) Sets the user's assistant. Parameters: assistant - A IUser object. setManager void setManager(IUser manager) Sets the user's manager. Parameters: manager - A IUser object. setHierarchicalManager void setHierarchicalManager(IUser hierarchicalManager) Sets the user's hierarchical manager. Parameters: hierarchicalManager - A IUser object. 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 boolean isConnectionAllowed() Checks if the user can open a connection. Returns: true if the user can open a connection, false otherwise. isLocked boolean isLocked() Checks if the user is locked. Returns: true if the user is locked, false otherwise. unlock void unlock() 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.

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

getFirstName

getLastName

getFullName

getNickName

getSex

getBirthday

getTitle

getEmployeeNumber

getContractType

getUserFunction

getSocialCategory

getEmail

getFaxNumber

getPhoneNumber

getMobilePhoneNumber

getAvatar

getSignature

getSkin

getLanguage

getActivationDate

getLastPasswordUpdate

getLastVisite

getLastVisitedDate

getEntry

getExit

getExpiration

getExpirationDate

getAddress1

getAddress2

getCity

getZipcode

getCountry

getCreatedDate

getCreatedBy

getModifiedDate

getModifiedBy

getDescription

getAssistant

getManager

getHierarchicalManager

getCollaborators

getLeaders

getOrganization

setOrganization

getLocalization

setLocalization

isMemberOf

isMemberOf

isMemberOf

isMemberOf

isMemberOf

isSubscriber

getParents

getAllParents

setLogin

setPassword

setFirstName

setLastName

setFullName

setNickName

setSex

setBirthday

setTitle

setEmployeeNumber

setContractType

setUserFunction

setSocialCategory

setEmail