org.cyclos.entities.users

Class User

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.users.BasicUser

org.cyclos.entities.users.User

All Implemented Interfaces:

java.lang.Cloneable, ProcessableForDataTranslation, DefinesNetwork, EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>, ImageOwner<User,UserImage>, ProductOwner, RoleContainer, AccountOwner, InternalAccountOwner, IEntity, INamedEntity, IUser

@Entity
public class User
extends BasicUser
implements ProductOwner, ImageOwner<User,UserImage>

The user extends the BasicUser with the relationship with a group, so that all user subclasses are required to have a group

Author:

luis, jefferson

Constructor Summary

Constructors

Constructor and Description
User()
User(Group group)

Method Summary

Modifier and Type	Method and Description
boolean	addProduct(Product product)
java.util.Set<Product>	doGetProducts()
java.lang.String	getAcceptedAgreementIds()
java.util.Set<UserAccount>	getAccounts()
java.util.Date	getActivationDate()
UserActivity	getActivity()
java.util.Set<UserAddress>	getAddresses()
java.util.Set<BasicAd>	getAds()
java.util.Set<AgreementLog>	getAgreementLogs()
java.util.Set<UserAlert>	getAlerts()
java.util.Set<Product>	getAllProducts()
java.util.Set<User>	getBrokeredUsers()
java.util.Set<BrokeringLog>	getBrokeringLogs()
java.util.Set<Brokering>	getBrokerings()
java.util.Set<Brokering>	getBrokeringsAsUser()
java.util.Set<User>	getBrokers()
java.util.Map<Channel,UserChannel>	getChannels()
java.util.Set<User>	getContacts()
java.util.Set<UserDashboardAction>	getDashboardActions()
Group	getGroup()
java.util.Set<UserGroupLog>	getGroupHistory()
java.util.Set<User>	getIgnoreFeedback()
UserImage	getImage() De-normalized reference to the first image
java.util.List<UserImage>	getImages()
java.lang.String	getIndividualProductIds()
EntityLogType	getLogType() If this entity generates log then it must returns its EntityLogType.
User	getMainBroker()
UserNature	getNature()
java.util.Set<Product>	getProducts()
java.util.Set<AdQuestion>	getQuestions()
java.util.Set<Reference>	getReferencesFrom()
java.util.Set<Reference>	getReferencesTo()
UserRegionalSettings	getRegionalSettings()
java.util.Set<TempImage>	getUploadedImages()
User	getUser() Returns the user associated with this basic user
boolean	isAdmin() Returns whether the Role.ADMIN is granted
boolean	isBroker() Returns whether the Role.BROKER is granted
boolean	isGlobalAdmin() Returns whether the Role.GLOBAL_ADMIN is granted
boolean	isHideEmail()
boolean	isMember() returns true if user has member role.
boolean	isNetworkAdmin() Returns whether the Role.NETWORK_ADMIN is granted
boolean	removeProduct(Product product)
void	setAcceptedAgreementIds(java.lang.String acceptedAgreementIds)
void	setAccounts(java.util.Set<UserAccount> accounts)
void	setActivationDate(java.util.Date activationDate)
void	setActivity(UserActivity activity)
void	setAddresses(java.util.Set<UserAddress> addresses)
void	setAds(java.util.Set<BasicAd> ads)
void	setAgreementLogs(java.util.Set<AgreementLog> agreementLogs)
void	setAlerts(java.util.Set<UserAlert> alerts)
void	setBrokeredUsers(java.util.Set<User> brokeredUsers)
void	setBrokeringLogs(java.util.Set<BrokeringLog> brokeringLogs)
void	setBrokers(java.util.Set<User> brokers)
void	setChannels(java.util.Map<Channel,UserChannel> channels)
void	setDashboardActions(java.util.Set<UserDashboardAction> dashboardActions)
void	setGroup(Group group)
void	setGroupHistory(java.util.Set<UserGroupLog> groupHistory)
void	setHideEmail(boolean hideEmail)
void	setIgnoreFeedback(java.util.Set<User> ignoreFeedback)
void	setImage(UserImage image) De-normalized reference to the first image
void	setImages(java.util.List<UserImage> images)
void	setIndividualProductIds(java.lang.String individualProductIds)
void	setQuestions(java.util.Set<AdQuestion> questions)
void	setReferencesFrom(java.util.Set<Reference> referencesFrom)
void	setReferencesTo(java.util.Set<Reference> referencesTo)
void	setRegionalSettings(UserRegionalSettings regionalSettings)
void	setTransientRegionalSettings(UserRegionalSettings transientRegionalSettings)
void	setUploadedImages(java.util.Set<TempImage> uploadedImages)

Methods inherited from class org.cyclos.entities.users.BasicUser

getCreationDate, getCustomFieldClass, getCustomFieldValueClass, getCustomValues, getDisplay, getEmail, getName, getNetwork, getNewEmail, getPasswords, getPasswordStatuses, getPhones, getPreferredMobilePhone, getPreferredPhone, getRegisteredBy, getRegistrationConfirmationDate, getRegistrationType, getSecurityAnswer, getSecurityQuestion, getShortDisplay, getStatus, getUsername, getValidationKey, getValidationKeyDate, getValidationKeyType, hasMobileEnabledForSMS, isActive, isAliasOperator, isBlocked, isInactive, isOperator, isPendingNewEmailValidation, isPendingValidation, isRemoved, isRestrictedOperator, isSendActivationEmail, isUserManager, setCreationDate, setCustomValues, setDisplay, setEmail, setName, setNetwork, setNewEmail, setPasswords, setPasswordStatuses, setPhones, setRegisteredBy, setRegistrationConfirmationDate, setRegistrationType, setSecurityAnswer, setSecurityQuestion, setSendActivationEmail, setShortDisplay, setStatus, setUsername, setValidationKey, setValidationKeyDate, setValidationKeyType, 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, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient

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

User

public User()

User

public User(Group group)

Method Detail

addProduct

public boolean addProduct(Product product)

Specified by:

addProduct in interface ProductOwner

doGetProducts

public java.util.Set<Product> doGetProducts()

getAcceptedAgreementIds

public java.lang.String getAcceptedAgreementIds()

getAccounts

public java.util.Set<UserAccount> getAccounts()

getActivationDate

public java.util.Date getActivationDate()

getActivity

public UserActivity getActivity()

getAddresses

public java.util.Set<UserAddress> getAddresses()

getAds

public java.util.Set<BasicAd> getAds()

getAgreementLogs

public java.util.Set<AgreementLog> getAgreementLogs()

getAlerts

public java.util.Set<UserAlert> getAlerts()

getAllProducts

public java.util.Set<Product> getAllProducts()

Specified by:

getAllProducts in interface ProductOwner

getBrokeredUsers

public java.util.Set<User> getBrokeredUsers()

getBrokeringLogs

public java.util.Set<BrokeringLog> getBrokeringLogs()

getBrokerings

public java.util.Set<Brokering> getBrokerings()

getBrokeringsAsUser

public java.util.Set<Brokering> getBrokeringsAsUser()

getBrokers

public java.util.Set<User> getBrokers()

getChannels

public java.util.Map<Channel,UserChannel> getChannels()

getContacts

public java.util.Set<User> getContacts()

getDashboardActions

public java.util.Set<UserDashboardAction> getDashboardActions()

getGroup

public Group getGroup()

getGroupHistory

public java.util.Set<UserGroupLog> getGroupHistory()

getIgnoreFeedback

public java.util.Set<User> getIgnoreFeedback()

getImage

public UserImage getImage()

Description copied from interface: ImageOwner

De-normalized reference to the first image

Specified by:

getImage in interface ImageOwner<User,UserImage>

getImages

public java.util.List<UserImage> getImages()

Specified by:

getImages in interface ImageOwner<User,UserImage>

getIndividualProductIds

public java.lang.String getIndividualProductIds()

getLogType

public EntityLogType getLogType()

Description copied from class: BaseEntity

If this entity generates log then it must returns its EntityLogType.

Overrides:

getLogType in class BaseEntity

Returns:

the corresponding EntityLogType. Null means it doesn't allow log.

getMainBroker

public User getMainBroker()

getNature

public UserNature getNature()

Specified by:

getNature in class BasicUser

getProducts

public java.util.Set<Product> getProducts()

Specified by:

getProducts in interface ProductOwner

getQuestions

public java.util.Set<AdQuestion> getQuestions()

getReferencesFrom

public java.util.Set<Reference> getReferencesFrom()

getReferencesTo

public java.util.Set<Reference> getReferencesTo()

getRegionalSettings

public UserRegionalSettings getRegionalSettings()

getUploadedImages

public java.util.Set<TempImage> getUploadedImages()

getUser

public User getUser()

Description copied from class: BasicUser

Returns the user associated with this basic user

Specified by:

getUser in class BasicUser

isAdmin

public boolean isAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.ADMIN is granted

Specified by:

isAdmin in interface RoleContainer

Overrides:

isAdmin in class BasicUser

isBroker

public boolean isBroker()

Description copied from interface: RoleContainer

Returns whether the Role.BROKER is granted

Specified by:

isBroker in interface RoleContainer

Overrides:

isBroker in class BasicUser

isGlobalAdmin

public boolean isGlobalAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.GLOBAL_ADMIN is granted

Specified by:

isGlobalAdmin in interface RoleContainer

Overrides:

isGlobalAdmin in class BasicUser

isHideEmail

public boolean isHideEmail()

isMember

public boolean isMember()

Description copied from class: BasicUser

returns true if user has member role. Note that a broker does not necessarily have a member role.

Specified by:

isMember in interface RoleContainer

Overrides:

isMember in class BasicUser

isNetworkAdmin

public boolean isNetworkAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.NETWORK_ADMIN is granted

Specified by:

isNetworkAdmin in interface RoleContainer

Overrides:

isNetworkAdmin in class BasicUser

removeProduct

public boolean removeProduct(Product product)

Specified by:

removeProduct in interface ProductOwner

setAcceptedAgreementIds

public void setAcceptedAgreementIds(java.lang.String acceptedAgreementIds)

setAccounts

public void setAccounts(java.util.Set<UserAccount> accounts)

setActivationDate

public void setActivationDate(java.util.Date activationDate)

setActivity

public void setActivity(UserActivity activity)

setAddresses

public void setAddresses(java.util.Set<UserAddress> addresses)

setAds

public void setAds(java.util.Set<BasicAd> ads)

setAgreementLogs

public void setAgreementLogs(java.util.Set<AgreementLog> agreementLogs)

setAlerts

public void setAlerts(java.util.Set<UserAlert> alerts)

setBrokeredUsers

public void setBrokeredUsers(java.util.Set<User> brokeredUsers)

setBrokeringLogs

public void setBrokeringLogs(java.util.Set<BrokeringLog> brokeringLogs)

setBrokers

public void setBrokers(java.util.Set<User> brokers)

setChannels

public void setChannels(java.util.Map<Channel,UserChannel> channels)

setDashboardActions

public void setDashboardActions(java.util.Set<UserDashboardAction> dashboardActions)

setGroup

public void setGroup(Group group)

setGroupHistory

public void setGroupHistory(java.util.Set<UserGroupLog> groupHistory)

setHideEmail

public void setHideEmail(boolean hideEmail)

setIgnoreFeedback

public void setIgnoreFeedback(java.util.Set<User> ignoreFeedback)

setImage

public void setImage(UserImage image)

Description copied from interface: ImageOwner

De-normalized reference to the first image

Specified by:

setImage in interface ImageOwner<User,UserImage>

setImages

public void setImages(java.util.List<UserImage> images)

Specified by:

setImages in interface ImageOwner<User,UserImage>

setIndividualProductIds

public void setIndividualProductIds(java.lang.String individualProductIds)

setQuestions

public void setQuestions(java.util.Set<AdQuestion> questions)

setReferencesFrom

public void setReferencesFrom(java.util.Set<Reference> referencesFrom)

setReferencesTo

public void setReferencesTo(java.util.Set<Reference> referencesTo)

setRegionalSettings

public void setRegionalSettings(UserRegionalSettings regionalSettings)

setTransientRegionalSettings

public void setTransientRegionalSettings(UserRegionalSettings transientRegionalSettings)

setUploadedImages

public void setUploadedImages(java.util.Set<TempImage> uploadedImages)