Class User
java.lang.Object
dev.getelements.elements.sdk.model.user.User
- All Implemented Interfaces:
Serializable
Represents a user in the system. Users are differing from entrants in that they are active users
who have special privilege to create/manage content in the system.
Created by patricktwohig on 3/19/15.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringUsed as the key for the user attribute where appropriate. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangetEmail()Gets the user's email address.getId()Gets the user's unique ID.getLevel()Gets the user's access level.getName()Gets the user's login name.static UserGets a special User object which is set to unprivileged.inthashCode()voidSets the user's emailvoidsetFirstName(String firstName) voidSets the unique ID of the user.voidsetLastName(String lastName) voidsetLevel(User.Level level) Sets the user's access level.voidsetLinkedAccounts(Set<String> linkedAccounts) voidSets the user's login name.voidsetPrimaryPhoneNb(String primaryPhoneNb) toString()
-
Field Details
-
USER_ATTRIBUTE
Used as the key for the user attribute where appropriate. This is equivalent to the FQN of theUserclass.
-
-
Constructor Details
-
User
public User()
-
-
Method Details
-
getId
Gets the user's unique ID.- Returns:
- the user's unique ID.
-
setId
Sets the unique ID of the user.- Parameters:
id- the user's unique ID
-
getName
Gets the user's login name.- Returns:
-
setName
Sets the user's login name.- Parameters:
name-
-
getEmail
Gets the user's email address. -
setEmail
Sets the user's email- Parameters:
email-
-
getLevel
Gets the user's access level.- Returns:
-
setLevel
Sets the user's access level.- Parameters:
level-
-
getUnprivileged
Gets a special User object which is set to unprivileged. This is used as a palceholder when a user is not logged in. This is a singleton object.- Returns:
- a User with the UNPRIVILEGED state set
-
getPrimaryPhoneNb
-
setPrimaryPhoneNb
-
getFirstName
-
getLastName
-
setFirstName
-
setLastName
-
getLinkedAccounts
-
setLinkedAccounts
-
equals
-
hashCode
public int hashCode() -
toString
-