Interface User
- All Superinterfaces:
Entity
,Resource
,Serializable
Represents a user in the system.
-
Method Summary
Modifier and TypeMethodDescriptionGet the list of additional email addressesGet the list of addresses.Gets the primary email address of the user.Gets the first name of the user.Get the gender of the user.Get the list of instant messaging accounts.Gets the current language preference for this user.Gets the last name of the user.Deprecated.This method will be removed in the future.Get the list of phone numbersGets the username of the user.Get the list of websites.Check if this user account is already activated or not.Deprecated.This method will be removed in the future.boolean
Check if this user account is currently enabled (able to log in) or not.Check if this user was a guest user or not.Check if this is an LDAP user or not.Methods inherited from interface Resource
getCreatedBy, getCreatedOn, getLastModifiedBy, getLastModifiedOn, getResourceType, isSystem
-
Method Details
-
getUserName
String getUserName()Gets the username of the user.- Returns:
- The username of the user
-
getFirstName
String getFirstName()Gets the first name of the user.- Returns:
- the first name of the user.
-
getLastName
String getLastName()Gets the last name of the user.- Returns:
- the last name of the user.
-
getEmailAddress
String getEmailAddress()Gets the primary email address of the user.- Returns:
- the primary email address of the user.
-
getGender
Gender getGender()Get the gender of the user.- Returns:
- the gender of the user.
-
isActivated
Boolean isActivated()Check if this user account is already activated or not.- Returns:
- True if this user is already activated. False otherwise.
-
isEnabled
boolean isEnabled()Check if this user account is currently enabled (able to log in) or not.- Returns:
- True if this user account is enabled. False if disabled.
-
isLdapUser
Boolean isLdapUser()Check if this is an LDAP user or not.- Returns:
- True if this is an LDAP user. False otherwise.
-
isGuestUser
Boolean isGuestUser()Check if this user was a guest user or not.- Returns:
- True if this was a guest user. False otherwise.
-
isApiUser
Deprecated.This method will be removed in the future.Check if this is an API user or not.- Returns:
- True if this user is an API user. False is not.
-
getLanguage
String getLanguage()Gets the current language preference for this user.- Returns:
- the current language preference for this user.
-
getAdditionalEmailAddresses
Get the list of additional email addresses- Returns:
- the list of additional email addresses
-
getPhoneNumbers
List<PhoneNumber> getPhoneNumbers()Get the list of phone numbers- Returns:
- the list of phone numbers
-
getInstantMessagingAccounts
List<InstantMessagingAccount> getInstantMessagingAccounts()Get the list of instant messaging accounts.- Returns:
- the list of instant messaging accounts.
-
getWebsites
Get the list of websites.- Returns:
- the list of websites.
-
getAddresses
Get the list of addresses.- Returns:
- the list of addresses.
-
getLicenseType
Deprecated.This method will be removed in the future.Get the given licenceType of the user. Given license type is no longer available for users. This method will always returnLicenseType.CONSUMER
for compatibility purposes.- Returns:
LicenseType.CONSUMER
-