BasicUser (Cyclos 4.6 Scripting API Documentation)

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

All Implemented Interfaces:

java.lang.Cloneable, HasEntityImportance, ProcessableForDataTranslation, DefinesNetwork, RoleContainer, AccountOwner, InternalAccountOwner, IEntity, INamedEntity, IUser

Direct Known Subclasses:

Operator, User
```
@Entity
public abstract class BasicUser
extends BaseEntity
implements IUser, INamedEntity, DefinesNetwork, RoleContainer
```
The root class for user hierarchy

Author:

luis

Constructor Summary

Constructors
Constructor and Description

BasicUser()

Constructors
Constructor and Description
`BasicUser()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Date`	`getCreationDate()`
`java.lang.String`	`getEmail()`
`java.lang.String`	`getName()`
`abstract UserNature`	`getNature()`
`Network`	`getNetwork()`
`java.lang.String`	`getNewEmail()`
`java.util.Set<Password>`	`getPasswords()`
`java.util.Date`	`getRegistrationConfirmationDate()`
`UserRegistration`	`getRegistrationType()`
`java.lang.String`	`getSecurityAnswer()`
`SecurityQuestion`	`getSecurityQuestion()`
`UserStatus`	`getStatus()`
`abstract User`	`getUser()` Returns the user associated with this basic user
`java.lang.String`	`getUsername()`
`java.lang.String`	`getValidationKey()`
`java.util.Date`	`getValidationKeyDate()`
`ValidationKeyType`	`getValidationKeyType()`
`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`	`isGlobalAdmin()` Returns whether the `Role.GLOBAL_ADMIN` is granted
`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`	`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`	`setCreationDate(java.util.Date creationDate)`
`void`	`setEmail(java.lang.String email)`
`void`	`setName(java.lang.String name)`
`void`	`setNetwork(Network network)`
`void`	`setNewEmail(java.lang.String newEmail)`
`void`	`setPasswords(java.util.Set<Password> passwords)`
`void`	`setRegistrationConfirmationDate(java.util.Date registrationConfirmationDate)`
`void`	`setRegistrationType(UserRegistration registrationType)`
`void`	`setSecurityAnswer(java.lang.String securityAnswer)`
`void`	`setSecurityQuestion(SecurityQuestion securityQuestion)`
`void`	`setSendActivationEmail(boolean sendActivationEmail)`
`void`	`setStatus(UserStatus status)`
`void`	`setUsername(java.lang.String username)`
`void`	`setValidationKey(java.lang.String validationKey)`
`void`	`setValidationKeyDate(java.util.Date validationKeyDate)`
`void`	`setValidationKeyType(ValidationKeyType validationKeyType)`
`java.lang.String`	`toString()`

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, getLogType, getVersion, isGlobal, isPersistent, isTransient

Methods inherited from class org.cyclos.entities.SimpleEntity
clone, equals, getEntityImportance, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode

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

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

- Constructor Detail
  - BasicUser
```
public BasicUser()
```
- Method Detail
  - getCreationDate
```
public java.util.Date getCreationDate()
```
  - getEmail
```
public java.lang.String getEmail()
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface INamedEntity
  - getNature
```
public abstract UserNature getNature()
```
  - getNetwork
```
public Network getNetwork()
```
    Specified by:
    
    getNetwork in class BaseEntity
    
    Returns:
    
    the network this entity belongs to
  - getNewEmail
```
public java.lang.String getNewEmail()
```
  - getPasswords
```
public java.util.Set<Password> getPasswords()
```
  - getRegistrationConfirmationDate
```
public java.util.Date getRegistrationConfirmationDate()
```
  - getRegistrationType
```
public UserRegistration getRegistrationType()
```
  - getSecurityAnswer
```
public java.lang.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 java.lang.String getUsername()
```
  - getValidationKey
```
public java.lang.String getValidationKey()
```
  - getValidationKeyDate
```
public java.util.Date getValidationKeyDate()
```
  - getValidationKeyType
```
public ValidationKeyType getValidationKeyType()
```
  - 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
  - isGlobalAdmin
```
public boolean isGlobalAdmin()
```
    Description copied from interface: RoleContainer
    
    Returns whether the Role.GLOBAL_ADMIN is granted
    
    Specified by:
    
    isGlobalAdmin in interface RoleContainer
  - isInactive
```
public boolean isInactive()
```
  - isMember
```
public boolean isMember()
```
    returns true if user has member role. Note that a broker does not necessarily have a 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()
```
  - 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
  - setCreationDate
```
public void setCreationDate(java.util.Date creationDate)
```
  - setEmail
```
public void setEmail(java.lang.String email)
```
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface INamedEntity
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork
  - setNewEmail
```
public void setNewEmail(java.lang.String newEmail)
```
  - setPasswords
```
public void setPasswords(java.util.Set<Password> passwords)
```
  - setRegistrationConfirmationDate
```
public void setRegistrationConfirmationDate(java.util.Date registrationConfirmationDate)
```
  - setRegistrationType
```
public void setRegistrationType(UserRegistration registrationType)
```
  - setSecurityAnswer
```
public void setSecurityAnswer(java.lang.String securityAnswer)
```
  - setSecurityQuestion
```
public void setSecurityQuestion(SecurityQuestion securityQuestion)
```
  - setSendActivationEmail
```
public void setSendActivationEmail(boolean sendActivationEmail)
```
  - setStatus
```
public void setStatus(UserStatus status)
```
  - setUsername
```
public void setUsername(java.lang.String username)
```
  - setValidationKey
```
public void setValidationKey(java.lang.String validationKey)
```
  - setValidationKeyDate
```
public void setValidationKeyDate(java.util.Date validationKeyDate)
```
  - setValidationKeyType
```
public void setValidationKeyType(ValidationKeyType validationKeyType)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class SimpleEntity

Class BasicUser

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.entities.BaseEntity

Methods inherited from class org.cyclos.entities.SimpleEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.model.IEntity

Constructor Detail

BasicUser

Method Detail

getCreationDate

getEmail

getName

getNature

getNetwork

getNewEmail

getPasswords

getRegistrationConfirmationDate

getRegistrationType

getSecurityAnswer

getSecurityQuestion

getStatus

getUser

getUsername

getValidationKey

getValidationKeyDate

getValidationKeyType

isActive

isAdmin

isAliasOperator

isBlocked

isBroker

isGlobalAdmin

isInactive

isMember

isNetworkAdmin

isOperator

isPendingNewEmailValidation

isPendingValidation

isRemoved

isRestrictedOperator

isSendActivationEmail

isUserManager

setCreationDate

setEmail

setName

setNetwork

setNewEmail

setPasswords

setRegistrationConfirmationDate

setRegistrationType

setSecurityAnswer

setSecurityQuestion

setSendActivationEmail

setStatus

setUsername

setValidationKey

setValidationKeyDate

setValidationKeyType

toString