org.cyclos.entities.users

Class User

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.users.BasicUser

org.cyclos.entities.users.User

All Implemented Interfaces:

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

@Entity
public class User
extends BasicUser
implements ProductOwner, EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>

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
void	addImage(UserImage image)
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.lang.Class<UserCustomFieldValue>	getCustomFieldValueClass() Returns the class for storing custom field values
java.util.Set<UserCustomFieldValue>	getCustomValues() Returns all custom field values
java.util.Set<UserDashboardAction>	getDashboardActions()
Group	getGroup()
java.util.Set<UserGroupLog>	getGroupHistory()
java.util.Set<User>	getIgnoreFeedback()
UserImage	getImage()
int	getImageCount()
java.util.List<UserImage>	getImages()
EntityLogType	getLogType() If this entity generates log then it must returns its EntityLogType.
User	getMainBroker()
java.util.List<MobilePhone>	getMobilesEnabledForSMS()
UserNature	getNature()
java.util.Set<Permission>	getPermissions()
java.util.Set<Phone>	getPhones()
MobilePhone	getPreferredMobilePhone() The preferred mobile phone - if there is a verified mobile, returns it.
Phone	getPreferredPhone() First attempts getPreferredMobilePhone().
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
java.util.Set<UserAddress>	getVisibleAddresses() Returns visible and located addresses
boolean	hasMobileEnabledForSMS()
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
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	setCustomValues(java.util.Set<UserCustomFieldValue> customValues)
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	setImages(java.util.List<UserImage> images)
void	setMainBroker(User mainBroker)
void	setPermissions(java.util.Set<Permission> permissions)
void	setPhones(java.util.Set<Phone> phones)
void	setProducts(java.util.Set<Product> products)
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	setUploadedImages(java.util.Set<TempImage> uploadedImages)

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

getCreationDate, getEmail, getName, getNetwork, getNewEmail, getPasswords, getRegistrationConfirmationDate, getRegistrationType, getSecurityAnswer, getSecurityQuestion, getStatus, getUsername, getValidationKey, getValidationKeyDate, getValidationKeyType, isActive, isAliasOperator, isBlocked, isInactive, isOperator, isPendingNewEmailValidation, isPendingValidation, isRemoved, isRestrictedOperator, isSendActivationEmail, isUserManager, setCreationDate, setEmail, setName, setNetwork, setNewEmail, setPasswords, setRegistrationConfirmationDate, setRegistrationType, setSecurityAnswer, setSecurityQuestion, setSendActivationEmail, setStatus, setUsername, setValidationKey, setValidationKeyDate, setValidationKeyType, 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

User

public User()

User

public User(Group group)

Method Detail

addImage

public void addImage(UserImage image)

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

getCustomFieldValueClass

public java.lang.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 java.util.Set<UserCustomFieldValue> getCustomValues()

Description copied from interface: EntityWithCustomValues

Returns all custom field values

Specified by:

getCustomValues in interface EntityWithCustomValues<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,UserCustomFieldValue>

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

getImageCount

public int getImageCount()

getImages

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

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

getMobilesEnabledForSMS

public java.util.List<MobilePhone> getMobilesEnabledForSMS()

getNature

public UserNature getNature()

Specified by:

getNature in class BasicUser

getPermissions

public java.util.Set<Permission> getPermissions()

getPhones

public java.util.Set<Phone> getPhones()

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.

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

getVisibleAddresses

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

Returns visible and located addresses

hasMobileEnabledForSMS

public boolean hasMobileEnabledForSMS()

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

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)

setCustomValues

public void setCustomValues(java.util.Set<UserCustomFieldValue> customValues)

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)

setImages

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

setMainBroker

public void setMainBroker(User mainBroker)

setPermissions

public void setPermissions(java.util.Set<Permission> permissions)

setPhones

public void setPhones(java.util.Set<Phone> phones)

setProducts

public void setProducts(java.util.Set<Product> products)

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)

setUploadedImages

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