java.lang.Object
- org.cyclos.entities.SimpleEntity
- - org.cyclos.entities.NetworkedEntity
  - - org.cyclos.entities.BaseEntity
    - - org.cyclos.entities.users.BasicUser

All Implemented Interfaces:

Cloneable, HasNetwork, ProcessableForDataTranslation, DefinesNetwork, EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>, RoleContainer, AccountOwner, InternalAccountOwner, IEntity, INamedEntity, IUser

Direct Known Subclasses:

Operator, User
```
@Entity
public abstract class BasicUser
extends BaseEntity
implements IUser, INamedEntity, DefinesNetwork, RoleContainer, EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>
```
The root class for user hierarchy

Field Summary

Fields
Modifier and Type Field Description

protected String brokerIds

protected UserImage image

Constructor Summary

Constructors
Constructor Description

BasicUser()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addFcmToken(UserFcmToken fcmToken)`	Add the given token to the user Warning: This method blindly add the given fcm token without checking if the token value already was assigned
`UserActivity`	`getActivity()`
`Date`	`getCreationDate()`
`Class<UserCustomField>`	`getCustomFieldClass()`	Returns custom field the class on this entity
`Class<UserCustomFieldValue>`	`getCustomFieldValueClass()`	Returns the class for storing custom field values
`Set<UserCustomFieldValue>`	`getCustomValues()`	Returns all custom field values
`String`	`getDisplayForManagers()`
`String`	`getDisplayForOthers()`
`String`	`getEmail()`
`Set<UserFcmToken>`	`getFcmTokens()`
`String`	`getForgotPasswordCode()`
`Date`	`getForgotPasswordCodeDate()`
`Frontend`	`getFrontend()`
`String`	`getIdentityProviderRequestId()`
`List<LandLinePhone>`	`getLandLinePhones()`	Returns only the land-line phones
`String`	`getLocale()`
`abstract Role`	`getMainRole()`
`Date`	`getMessagesLastViewDate()`	Returns the last view date for the messages from the user activity, if any.
`List<MobilePhone>`	`getMobilePhones()`	Returns only the mobile phones
`String`	`getName()`
`abstract UserNature`	`getNature()`
`Network`	`getNetwork()`	Returns the network this entity belongs to
`String`	`getNewEmail()`
`Date`	`getNotificationsLastViewDate()`	Returns the last view date for the notifications from the user activity, if any.
`Set<Password>`	`getPasswords()`
`String`	`getPasswordStatuses()`
`Set<Phone>`	`getPhones()`
`LandLinePhone`	`getPreferredLandLinePhone()`	The preferred land-line phone - actually the first returned land-line phone
`MobilePhone`	`getPreferredMobilePhone()`	The preferred mobile phone - if there is a verified mobile, returns it.
`Phone`	`getPreferredPhone()`	First attempts `getPreferredMobilePhone()`.
`BasicUser`	`getRegisteredBy()`
`Date`	`getRegistrationConfirmationDate()`
`UserRegistration`	`getRegistrationType()`
`String`	`getSecurityAnswer()`
`SecurityQuestion`	`getSecurityQuestion()`
`UserStatus`	`getStatus()`
`abstract User`	`getUser()`	Returns the user associated with this basic user
`String`	`getUsername()`
`String`	`getValidationKey()`
`Date`	`getValidationKeyDate()`
`ValidationKeyType`	`getValidationKeyType()`
`boolean`	`hasMobileEnabledForSMS()`
`boolean`	`isActive()`
`boolean`	`isAdmin()`	Returns whether the `Role.ADMIN` is granted
`boolean`	`isAliasOperator()`	Returns whether the `Role.ALIAS_OPERATOR` is granted
`boolean`	`isBlocked()`
`boolean`	`isBroker()`	Returns whether the `Role.BROKER` is granted
`boolean`	`isEmailVerified()`
`boolean`	`isGlobalAdmin()`	Returns whether the `Role.GLOBAL_ADMIN` is granted Returns true if the user is the "root" user.
`boolean`	`isInactive()`
`boolean`	`isMember()`	returns true if user has member role.
`boolean`	`isNetworkAdmin()`	Returns whether the `Role.NETWORK_ADMIN` is granted
`boolean`	`isOperator()`	Returns whether the `Role.OPERATOR` is granted
`boolean`	`isPendingNewEmailValidation()`	Returns true if the user's email modification is pending from being validated.
`boolean`	`isPendingValidation()`
`boolean`	`isPurged()`
`boolean`	`isRemoved()`
`boolean`	`isRestrictedOperator()`	Returns whether the `Role.RESTRICTED_OPERATOR` is granted
`boolean`	`isSendActivationEmail()`
`boolean`	`isUserManager()`	Returns whether the `Role.ADMIN` or `Role.BROKER` roles are granted
`void`	`removeFcmToken(UserFcmToken fcmToken)`
`void`	`setActivity(UserActivity activity)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setCustomValues(Set<UserCustomFieldValue> customValues)`
`void`	`setDisplayForManagers(String displayForManagers)`
`void`	`setDisplayForOthers(String displayForOthers)`
`void`	`setEmail(String email)`
`void`	`setEmailVerified(boolean emailVerified)`
`void`	`setFcmTokens(Set<UserFcmToken> fcmTokens)`
`void`	`setForgotPasswordCode(String forgotPasswordCode)`
`void`	`setForgotPasswordCodeDate(Date forgotPasswordCodeDate)`
`void`	`setFrontend(Frontend frontend)`
`void`	`setIdentityProviderRequestId(String identityProviderRequestId)`
`void`	`setLocale(String locale)`
`void`	`setName(String name)`
`void`	`setNetwork(Network network)`
`void`	`setNewEmail(String newEmail)`
`void`	`setPasswords(Set<Password> passwords)`
`void`	`setPasswordStatuses(String passwordStatuses)`
`void`	`setPhones(Set<Phone> phones)`
`void`	`setRegisteredBy(BasicUser registeredBy)`
`void`	`setRegistrationConfirmationDate(Date registrationConfirmationDate)`
`void`	`setRegistrationType(UserRegistration registrationType)`
`void`	`setSecurityAnswer(String securityAnswer)`
`void`	`setSecurityQuestion(SecurityQuestion securityQuestion)`
`void`	`setSendActivationEmail(boolean sendActivationEmail)`
`void`	`setStatus(UserStatus status)`
`void`	`setUsername(String username)`
`void`	`setValidationKey(String validationKey)`
`void`	`setValidationKeyDate(Date validationKeyDate)`
`void`	`setValidationKeyType(ValidationKeyType validationKeyType)`
`String`	`toString()`

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity
isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity
clone, equals, getId, hashCode, id, ids, isPersistent, isTransient, setId, toShortString, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity
getId, matches

- Field Detail
  - image
```
protected UserImage image
```
  - brokerIds
```
protected String brokerIds
```
- Constructor Detail
  - BasicUser
```
public BasicUser()
```
- Method Detail
  - addFcmToken
```
public void addFcmToken(UserFcmToken fcmToken)
```
    Add the given token to the user Warning: This method blindly add the given fcm token without checking if the token value already was assigned
  - getActivity
```
public UserActivity getActivity()
```
  - getCreationDate
```
public Date getCreationDate()
```
  - getCustomFieldClass
```
public Class<UserCustomField> getCustomFieldClass()
```
    Description copied from interface: EntityWithCustomValues
    
    Returns custom field the class on this entity
    
    Specified by:
    
    getCustomFieldClass in interface EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>
  - getCustomFieldValueClass
```
public Class<UserCustomFieldValue> getCustomFieldValueClass()
```
    Description copied from interface: EntityWithCustomValues
    
    Returns the class for storing custom field values
    
    Specified by:
    
    getCustomFieldValueClass in interface EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>
  - getCustomValues
```
public Set<UserCustomFieldValue> getCustomValues()
```
    Description copied from interface: EntityWithCustomValues
    
    Returns all custom field values
    
    Specified by:
    
    getCustomValues in interface EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>
  - getDisplayForManagers
```
public String getDisplayForManagers()
```
  - getDisplayForOthers
```
public String getDisplayForOthers()
```
  - getEmail
```
public String getEmail()
```
  - getFcmTokens
```
public Set<UserFcmToken> getFcmTokens()
```
  - getForgotPasswordCode
```
public String getForgotPasswordCode()
```
  - getForgotPasswordCodeDate
```
public Date getForgotPasswordCodeDate()
```
  - getFrontend
```
public Frontend getFrontend()
```
  - getIdentityProviderRequestId
```
public String getIdentityProviderRequestId()
```
  - getLandLinePhones
```
public List<LandLinePhone> getLandLinePhones()
```
    Returns only the land-line phones
  - getLocale
```
public String getLocale()
```
  - getMainRole
```
public abstract Role getMainRole()
```
  - getMessagesLastViewDate
```
public Date getMessagesLastViewDate()
```
    Returns the last view date for the messages from the user activity, if any.
  - getMobilePhones
```
public List<MobilePhone> getMobilePhones()
```
    Returns only the mobile phones
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface INamedEntity
  - getNature
```
public abstract UserNature getNature()
```
  - getNetwork
```
public Network getNetwork()
```
    Description copied from interface: HasNetwork
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in interface HasNetwork
  - getNewEmail
```
public String getNewEmail()
```
  - getNotificationsLastViewDate
```
public Date getNotificationsLastViewDate()
```
    Returns the last view date for the notifications from the user activity, if any.
  - getPasswords
```
public Set<Password> getPasswords()
```
  - getPasswordStatuses
```
public String getPasswordStatuses()
```
  - getPhones
```
public Set<Phone> getPhones()
```
  - getPreferredLandLinePhone
```
public LandLinePhone getPreferredLandLinePhone()
```
    The preferred land-line phone - actually the first returned land-line phone
  - getPreferredMobilePhone
```
public MobilePhone getPreferredMobilePhone()
```
    The preferred mobile phone - if there is a verified mobile, returns it. Otherwise, any mobile phone.
  - getPreferredPhone
```
public Phone getPreferredPhone()
```
    First attempts getPreferredMobilePhone(). If none is found, returns the first land-line. Otherwise returns null.
  - getRegisteredBy
```
public BasicUser getRegisteredBy()
```
  - getRegistrationConfirmationDate
```
public Date getRegistrationConfirmationDate()
```
  - getRegistrationType
```
public UserRegistration getRegistrationType()
```
  - getSecurityAnswer
```
public String getSecurityAnswer()
```
  - getSecurityQuestion
```
public SecurityQuestion getSecurityQuestion()
```
  - getStatus
```
public UserStatus getStatus()
```
  - getUser
```
public abstract User getUser()
```
    Returns the user associated with this basic user
  - getUsername
```
public String getUsername()
```
  - getValidationKey
```
public String getValidationKey()
```
  - getValidationKeyDate
```
public Date getValidationKeyDate()
```
  - getValidationKeyType
```
public ValidationKeyType getValidationKeyType()
```
  - hasMobileEnabledForSMS
```
public boolean hasMobileEnabledForSMS()
```
  - isActive
```
public boolean isActive()
```
  - isAdmin
```
public boolean isAdmin()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.ADMIN is granted
    
    Specified by:
    
    isAdmin in interface RoleContainer
  - isAliasOperator
```
public boolean isAliasOperator()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.ALIAS_OPERATOR is granted
    
    Specified by:
    
    isAliasOperator in interface RoleContainer
  - isBlocked
```
public boolean isBlocked()
```
  - isBroker
```
public boolean isBroker()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.BROKER is granted
    
    Specified by:
    
    isBroker in interface RoleContainer
  - isEmailVerified
```
public boolean isEmailVerified()
```
  - isGlobalAdmin
```
public boolean isGlobalAdmin()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.GLOBAL_ADMIN is granted Returns true if the user is the "root" user. For multi-networks administrators it returns false
    
    Specified by:
    
    isGlobalAdmin in interface RoleContainer
    
    See Also:
    
    RoleContainer.isGlobalAdmin()
  - isInactive
```
public boolean isInactive()
```
  - isMember
```
public boolean isMember()
```
    returns true if user has member role.
    
    Specified by:
    
    isMember in interface RoleContainer
  - isNetworkAdmin
```
public boolean isNetworkAdmin()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.NETWORK_ADMIN is granted
    
    Specified by:
    
    isNetworkAdmin in interface RoleContainer
  - isOperator
```
public boolean isOperator()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.OPERATOR is granted
    
    Specified by:
    
    isOperator in interface RoleContainer
  - isPendingNewEmailValidation
```
public boolean isPendingNewEmailValidation()
```
    Returns true if the user's email modification is pending from being validated.
  - isPendingValidation
```
public boolean isPendingValidation()
```
  - isPurged
```
public boolean isPurged()
```
  - isRemoved
```
public boolean isRemoved()
```
  - isRestrictedOperator
```
public boolean isRestrictedOperator()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.RESTRICTED_OPERATOR is granted
    
    Specified by:
    
    isRestrictedOperator in interface RoleContainer
  - isSendActivationEmail
```
public boolean isSendActivationEmail()
```
  - isUserManager
```
public boolean isUserManager()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.ADMIN or Role.BROKER roles are granted
    
    Specified by:
    
    isUserManager in interface RoleContainer
  - removeFcmToken
```
public void removeFcmToken(UserFcmToken fcmToken)
```
  - setActivity
```
public void setActivity(UserActivity activity)
```
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
  - setCustomValues
```
public void setCustomValues(Set<UserCustomFieldValue> customValues)
```
  - setDisplayForManagers
```
public void setDisplayForManagers(String displayForManagers)
```
  - setDisplayForOthers
```
public void setDisplayForOthers(String displayForOthers)
```
  - setEmail
```
public void setEmail(String email)
```
  - setEmailVerified
```
public void setEmailVerified(boolean emailVerified)
```
  - setFcmTokens
```
public void setFcmTokens(Set<UserFcmToken> fcmTokens)
```
  - setForgotPasswordCode
```
public void setForgotPasswordCode(String forgotPasswordCode)
```
  - setForgotPasswordCodeDate
```
public void setForgotPasswordCodeDate(Date forgotPasswordCodeDate)
```
  - setFrontend
```
public void setFrontend(Frontend frontend)
```
  - setIdentityProviderRequestId
```
public void setIdentityProviderRequestId(String identityProviderRequestId)
```
  - setLocale
```
public void setLocale(String locale)
```
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface INamedEntity
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork
  - setNewEmail
```
public void setNewEmail(String newEmail)
```
  - setPasswords
```
public void setPasswords(Set<Password> passwords)
```
  - setPasswordStatuses
```
public void setPasswordStatuses(String passwordStatuses)
```
  - setPhones
```
public void setPhones(Set<Phone> phones)
```
  - setRegisteredBy
```
public void setRegisteredBy(BasicUser registeredBy)
```
  - setRegistrationConfirmationDate
```
public void setRegistrationConfirmationDate(Date registrationConfirmationDate)
```
  - setRegistrationType
```
public void setRegistrationType(UserRegistration registrationType)
```
  - setSecurityAnswer
```
public void setSecurityAnswer(String securityAnswer)
```
  - setSecurityQuestion
```
public void setSecurityQuestion(SecurityQuestion securityQuestion)
```
  - setSendActivationEmail
```
public void setSendActivationEmail(boolean sendActivationEmail)
```
  - setStatus
```
public void setStatus(UserStatus status)
```
  - setUsername
```
public void setUsername(String username)
```
  - setValidationKey
```
public void setValidationKey(String validationKey)
```
  - setValidationKeyDate
```
public void setValidationKeyDate(Date validationKeyDate)
```
  - setValidationKeyType
```
public void setValidationKeyType(ValidationKeyType validationKeyType)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SimpleEntity

Fields
Modifier and Type	Field	Description
`protected String`	`brokerIds`
`protected UserImage`	`image`

Class BasicUser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.entities.BaseEntity

Methods inherited from class org.cyclos.entities.NetworkedEntity

Methods inherited from class org.cyclos.entities.SimpleEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.model.IEntity

Field Detail

image

brokerIds

Constructor Detail

BasicUser

Method Detail

addFcmToken

getActivity

getCreationDate

getCustomFieldClass

getCustomFieldValueClass

getCustomValues

getDisplayForManagers

getDisplayForOthers

getEmail

getFcmTokens

getForgotPasswordCode

getForgotPasswordCodeDate

getFrontend

getIdentityProviderRequestId

getLandLinePhones

getLocale

getMainRole

getMessagesLastViewDate

getMobilePhones

getName

getNature

getNetwork

getNewEmail

getNotificationsLastViewDate

getPasswords

getPasswordStatuses

getPhones

getPreferredLandLinePhone

getPreferredMobilePhone

getPreferredPhone

getRegisteredBy

getRegistrationConfirmationDate

getRegistrationType

getSecurityAnswer

getSecurityQuestion

getStatus

getUser

getUsername

getValidationKey

getValidationKeyDate

getValidationKeyType

hasMobileEnabledForSMS

isActive

isAdmin

isAliasOperator

isBlocked

isBroker

isEmailVerified

isGlobalAdmin

isInactive

isMember

isNetworkAdmin

isOperator

isPendingNewEmailValidation

isPendingValidation

isPurged

isRemoved

isRestrictedOperator

isSendActivationEmail

isUserManager

removeFcmToken

setActivity

setCreationDate

setCustomValues

setDisplayForManagers