org.cyclos.entities.users

Class BasicUser

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.users.BasicUser

All Implemented Interfaces:

java.lang.Cloneable, org.cyclos.entities.HasEntityImportance, DefinesNetwork, AccountOwner, InternalAccountOwner, IEntity, INamedEntity, IUser

Direct Known Subclasses:

Operator, User

@Entity
public abstract class BasicUser
extends org.cyclos.entities.BaseEntity
implements IUser, INamedEntity, DefinesNetwork

The root class for user hierarchy

Author:

luis

Constructor Summary

Constructors

Constructor and Description
BasicUser()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreationDate()
java.lang.String	getEmail()
java.util.Set<LoginHistoryLog>	getLoginHistory()
java.lang.String	getName()
abstract UserNature	getNature()
Network	getNetwork()
java.lang.String	getNewEmail()
java.util.Set<Password>	getPasswords()
java.util.Date	getRegistrationConfirmationDate()
abstract java.util.Set<Role>	getRoles() Returns all roles this user have
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()
boolean	isBlocked()
boolean	isBroker()
boolean	isGlobalAdmin()
boolean	isInactive()
boolean	isMember() returns true if user has member role.
boolean	isNetworkAdmin()
boolean	isOperator()
boolean	isPendingNewEmailValidation() Returns true if the user's email modification is pending from being validated.
boolean	isPendingValidation()
boolean	isRemoved()
boolean	isUserManagement()
void	setCreationDate(java.util.Date creationDate)
void	setEmail(java.lang.String email)
void	setLoginHistory(java.util.Set<LoginHistoryLog> loginHistory)
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	setSecurityAnswer(java.lang.String securityAnswer)
void	setSecurityQuestion(SecurityQuestion securityQuestion)
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, 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()

getLoginHistory

public java.util.Set<LoginHistoryLog> getLoginHistory()

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 org.cyclos.entities.BaseEntity

getNewEmail

public java.lang.String getNewEmail()

getPasswords

public java.util.Set<Password> getPasswords()

getRegistrationConfirmationDate

public java.util.Date getRegistrationConfirmationDate()

getRoles

public abstract java.util.Set<Role> getRoles()

Returns all roles this user have

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()

isBlocked

public boolean isBlocked()

isBroker

public boolean isBroker()

isGlobalAdmin

public boolean isGlobalAdmin()

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.

isNetworkAdmin

public boolean isNetworkAdmin()

isOperator

public boolean isOperator()

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()

isUserManagement

public boolean isUserManagement()

setCreationDate

public void setCreationDate(java.util.Date creationDate)

setEmail

public void setEmail(java.lang.String email)

setLoginHistory

public void setLoginHistory(java.util.Set<LoginHistoryLog> loginHistory)

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)

setSecurityAnswer

public void setSecurityAnswer(java.lang.String securityAnswer)

setSecurityQuestion

public void setSecurityQuestion(SecurityQuestion securityQuestion)

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 org.cyclos.entities.SimpleEntity