Package 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:

Cloneable, OtpOwner, HasNetwork, ProcessableForProxying, 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

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

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

brokerIds, image

Constructor Summary

Constructors

Constructor	Description
User()	Deprecated.
User(Group group)

Method Summary

Modifier and Type	Method	Description
void	addAgreementLog(AgreementLog log)	This method must be used to leave the data model consistent.
Set<Product>	doGetProducts()
String	getAcceptedAgreementIds()
Set<Agreement>	getAcceptedAgreements()
Date	getActivationDate()
Set<UserAddress>	getAddresses()
Set<BasicAd>	getAds()
Set<AgreementLog>	getAgreementLogs()
Set<UserAlert>	getAlerts()
Set<User>	getBrokeredUsers()
Set<Long>	getBrokerIds()
Set<BrokeringLog>	getBrokeringLogs()
Set<Brokering>	getBrokerings()
Set<Brokering>	getBrokeringsAsUser()
Set<User>	getBrokers()
UserChannel	getChannel(Channel channel)
Set<UserChannel>	getChannels()
Set<ContactInfo>	getContactInfos()
Set<UserQuickAccess>	getDashboardActions()
UserAddress	getDefaultAddress()
ExternalPayment	getExternalPayment()
Group	getGroup()
Set<UserGroupLog>	getGroupHistory()
GroupSet	getGroupSet()
Set<User>	getIgnoreFeedback()
UserImage	getImage()	Either the single image or a de-normalized reference to the first image
Long	getImageId()
List<UserImage>	getImages()	Either all images or a collection with the single image
String	getIndividualProductIds()
BasicUser	getInvitedBy()
String	getInviteToken()
User	getMainBroker()
Role	getMainRole()
UserNature	getNature()
ProductOwner	getNextLevelProductOwner()	Returns a possibly null next-level owner
Set<Product>	getPhysicalProducts()	Returns the persistent and attached products collection that can be modified to cascade
Set<PrivacyControl>	getPrivacyControls()
SortedSet<Long>	getProductIds()	Returns the redundant product ids directly assigned to this owner
Set<Product>	getProducts()	Returns all products directly assigned to this owner
Set<AdQuestion>	getQuestions()
Set<Reference>	getReferencesFrom()
Set<Reference>	getReferencesTo()
List<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	isEnablePrivacyControl()
boolean	isGlobalAdmin()	Returns whether the Role.GLOBAL_ADMIN is granted Returns true if the user is the "root" user.
boolean	isHideEmail()
boolean	isMember()	returns true if user has member role.
boolean	isNetworkAdmin()	Returns whether the Role.NETWORK_ADMIN is granted
boolean	isPhysicallyRemoving()
void	setAcceptedAgreements(Set<Agreement> acceptedAgreements)
void	setActivationDate(Date activationDate)
void	setAddresses(Set<UserAddress> addresses)
void	setAds(Set<BasicAd> ads)
void	setAgreementLogs(Set<AgreementLog> agreementLogs)
void	setAlerts(Set<UserAlert> alerts)
void	setBrokeredUsers(Set<User> brokeredUsers)
void	setBrokerIds(Set<Long> brokerIds)
void	setBrokeringLogs(Set<BrokeringLog> brokeringLogs)
void	setBrokers(Set<User> brokers)
void	setChannels(Set<UserChannel> channels)
void	setContactInfos(Set<ContactInfo> contactInfos)
void	setDashboardActions(Set<UserQuickAccess> dashboardActions)
void	setEnablePrivacyControl(boolean enablePrivacyControl)
void	setExternalPayment(ExternalPayment externalPayment)
void	setGroup(Group group)
void	setGroupHistory(Set<UserGroupLog> groupHistory)
void	setHideEmail(boolean hideEmail)
void	setIgnoreFeedback(Set<User> ignoreFeedback)
void	setImage(UserImage image)	Either the single image or a de-normalized reference to the first image
void	setImages(List<UserImage> images)	Assigns either all images or the first image if the owner has a single one
void	setInvitedBy(BasicUser invitedBy)
void	setInviteToken(String inviteToken)
void	setPhysicallyRemoving(boolean physicallyRemoving)
void	setPrivacyControls(Set<PrivacyControl> privacyControls)
void	setQuestions(Set<AdQuestion> questions)
void	setReferencesFrom(Set<Reference> referencesFrom)
void	setReferencesTo(Set<Reference> referencesTo)
void	setUploadedImages(List<TempImage> uploadedImages)
void	updateProductIds(SortedSet<Long> productIds)	Sets the redundant comma-separated list of product ids directly assigned to this owner

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

addFcmToken, getActivity, getCreationDate, getCustomFieldClass, getCustomFieldValueClass, getCustomValues, getDisplayForManagers, getDisplayForOthers, getEmail, getFavoriteAds, getFcmTokens, getFrontend, getIdentityProviderRequestId, getLandLinePhones, getLocale, getMessagesLastViewDate, getMobilePhones, getName, getNetwork, getNewEmail, getNotificationsLastViewDate, getOtpOwnerPathName, getOtps, getOtpUser, getPasswords, getPasswordStatuses, getPhones, getPreferredLandLinePhone, getPreferredMobilePhone, getPreferredPhone, getRegisteredBy, getRegistrationConfirmationDate, getRegistrationType, getSecurityAnswer, getSecurityQuestion, getStatus, getTotpSecret, getUsername, getValidationKey, getValidationKeyDate, getValidationKeyType, hasMobileEnabledForSMS, hasVerifiedMobilePhone, isActive, isAliasOperator, isBlocked, isEmailVerified, isInactive, isOperator, isPendingNewEmailValidation, isPendingValidation, isPurged, isRemoved, isRestrictedOperator, isSendActivationEmail, isUserManager, removeFcmToken, setActivity, setAsOwnerFor, setCreationDate, setCustomValues, setDisplayForManagers, setDisplayForOthers, setEmail, setEmailVerified, setFavoriteAds, setFcmTokens, setFrontend, setIdentityProviderRequestId, setLocale, setName, setNetwork, setNewEmail, setPasswords, setPasswordStatuses, setPhones, setRegisteredBy, setRegistrationConfirmationDate, setRegistrationType, setSecurityAnswer, setSecurityQuestion, setSendActivationEmail, setStatus, setTotpSecret, 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

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, toShortString, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.entities.HasNetwork

getNetwork, isGlobal

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.entities.access.OtpOwner

resolveOwnerPath

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.entities.users.ProductOwner

addProduct, getAllProductIds, removeProduct

Methods inherited from interface org.cyclos.entities.users.RoleContainer

isMemberOnly

Constructor Detail

User

@Deprecated
public User()

Deprecated.

This should never be used programmatically because the user always needs the group. It is here to cover the reflection use cases.

User

public User(Group group)

Method Detail

addAgreementLog

public void addAgreementLog(AgreementLog log)

This method must be used to leave the data model consistent. It updates the relationship on both sides.

doGetProducts

public Set<Product> doGetProducts()

getAcceptedAgreementIds

public String getAcceptedAgreementIds()

getAcceptedAgreements

public Set<Agreement> getAcceptedAgreements()

getActivationDate

public Date getActivationDate()

getAddresses

public Set<UserAddress> getAddresses()

getAds

public Set<BasicAd> getAds()

getAgreementLogs

public Set<AgreementLog> getAgreementLogs()

getAlerts

public Set<UserAlert> getAlerts()

getBrokeredUsers

public Set<User> getBrokeredUsers()

getBrokerIds

public Set<Long> getBrokerIds()

getBrokeringLogs

public Set<BrokeringLog> getBrokeringLogs()

getBrokerings

public Set<Brokering> getBrokerings()

getBrokeringsAsUser

public Set<Brokering> getBrokeringsAsUser()

getBrokers

public Set<User> getBrokers()

getChannel

public UserChannel getChannel(Channel channel)

getChannels

public Set<UserChannel> getChannels()

getContactInfos

public Set<ContactInfo> getContactInfos()

getDashboardActions

public Set<UserQuickAccess> getDashboardActions()

getDefaultAddress

public UserAddress getDefaultAddress()

getExternalPayment

public ExternalPayment getExternalPayment()

getGroup

public Group getGroup()

getGroupHistory

public Set<UserGroupLog> getGroupHistory()

getGroupSet

public GroupSet getGroupSet()

getIgnoreFeedback

public Set<User> getIgnoreFeedback()

getImage

public UserImage getImage()

Description copied from interface: ImageOwner

Either the single image or a de-normalized reference to the first image

Specified by:

getImage in interface ImageOwner<User,UserImage>

getImageId

public Long getImageId()

getImages

public List<UserImage> getImages()

Description copied from interface: ImageOwner

Either all images or a collection with the single image

Specified by:

getImages in interface ImageOwner<User,UserImage>

getIndividualProductIds

public String getIndividualProductIds()

getInvitedBy

public BasicUser getInvitedBy()

getInviteToken

public String getInviteToken()

getMainBroker

public User getMainBroker()

getMainRole

public Role getMainRole()

Specified by:

getMainRole in class BasicUser

getNature

public UserNature getNature()

Specified by:

getNature in class BasicUser

getNextLevelProductOwner

public ProductOwner getNextLevelProductOwner()

Description copied from interface: ProductOwner

Returns a possibly null next-level owner

Specified by:

getNextLevelProductOwner in interface ProductOwner

getPhysicalProducts

public Set<Product> getPhysicalProducts()

Description copied from interface: ProductOwner

Returns the persistent and attached products collection that can be modified to cascade

Specified by:

getPhysicalProducts in interface ProductOwner

getPrivacyControls

public Set<PrivacyControl> getPrivacyControls()

getProductIds

public SortedSet<Long> getProductIds()

Description copied from interface: ProductOwner

Returns the redundant product ids directly assigned to this owner

Specified by:

getProductIds in interface ProductOwner

getProducts

public Set<Product> getProducts()

Description copied from interface: ProductOwner

Returns all products directly assigned to this owner

Specified by:

getProducts in interface ProductOwner

getQuestions

public Set<AdQuestion> getQuestions()

getReferencesFrom

public Set<Reference> getReferencesFrom()

getReferencesTo

public Set<Reference> getReferencesTo()

getUploadedImages

public List<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

isEnablePrivacyControl

public boolean isEnablePrivacyControl()

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

Overrides:

isGlobalAdmin in class BasicUser

See Also:

RoleContainer.isGlobalAdmin()

isHideEmail

public boolean isHideEmail()

isMember

public boolean isMember()

Description copied from class: BasicUser

returns true if user has 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

isPhysicallyRemoving

public boolean isPhysicallyRemoving()

setAcceptedAgreements

public void setAcceptedAgreements(Set<Agreement> acceptedAgreements)

setActivationDate

public void setActivationDate(Date activationDate)

setAddresses

public void setAddresses(Set<UserAddress> addresses)

setAds

public void setAds(Set<BasicAd> ads)

setAgreementLogs

public void setAgreementLogs(Set<AgreementLog> agreementLogs)

setAlerts

public void setAlerts(Set<UserAlert> alerts)

setBrokeredUsers

public void setBrokeredUsers(Set<User> brokeredUsers)

setBrokerIds

public void setBrokerIds(Set<Long> brokerIds)

setBrokeringLogs

public void setBrokeringLogs(Set<BrokeringLog> brokeringLogs)

setBrokers

public void setBrokers(Set<User> brokers)

setChannels

public void setChannels(Set<UserChannel> channels)

setContactInfos

public void setContactInfos(Set<ContactInfo> contactInfos)

setDashboardActions

public void setDashboardActions(Set<UserQuickAccess> dashboardActions)

setEnablePrivacyControl

public void setEnablePrivacyControl(boolean enablePrivacyControl)

setExternalPayment

public void setExternalPayment(ExternalPayment externalPayment)

setGroup

public void setGroup(Group group)

setGroupHistory

public void setGroupHistory(Set<UserGroupLog> groupHistory)

setHideEmail

public void setHideEmail(boolean hideEmail)

setIgnoreFeedback

public void setIgnoreFeedback(Set<User> ignoreFeedback)

setImage

public void setImage(UserImage image)

Description copied from interface: ImageOwner

Either the single image or a de-normalized reference to the first image

Specified by:

setImage in interface ImageOwner<User,UserImage>

setImages

public void setImages(List<UserImage> images)

Description copied from interface: ImageOwner

Assigns either all images or the first image if the owner has a single one

Specified by:

setImages in interface ImageOwner<User,UserImage>

setInvitedBy

public void setInvitedBy(BasicUser invitedBy)

setInviteToken

public void setInviteToken(String inviteToken)

setPhysicallyRemoving

public void setPhysicallyRemoving(boolean physicallyRemoving)

setPrivacyControls

public void setPrivacyControls(Set<PrivacyControl> privacyControls)

setQuestions

public void setQuestions(Set<AdQuestion> questions)

setReferencesFrom

public void setReferencesFrom(Set<Reference> referencesFrom)

setReferencesTo

public void setReferencesTo(Set<Reference> referencesTo)

setUploadedImages

public void setUploadedImages(List<TempImage> uploadedImages)

updateProductIds

public void updateProductIds(SortedSet<Long> productIds)

Description copied from interface: ProductOwner

Sets the redundant comma-separated list of product ids directly assigned to this owner

Specified by:

updateProductIds in interface ProductOwner