Package com.axelor.auth.db
Class User
- java.lang.Object
-
- com.axelor.db.Model
-
- com.axelor.auth.db.AuditableModel
-
- com.axelor.auth.db.User
-
@Entity public class User extends AuditableModel
This object stores the users.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddMetaPermission(MetaPermission item)Add the givenMetaPermissionitem to themetaPermissionscollection.voidaddPermission(Permission item)Add the givenPermissionitem to thepermissionscollection.voidaddRole(Role item)Add the givenRoleitem to therolescollection.voidclearMetaPermissions()Clear themetaPermissionscollection.voidclearPermissions()Clear thepermissionscollection.voidclearRoles()Clear therolescollection.booleanequals(Object obj)LocalDateTimegetActivateOn()Activate the user from the specified date.BooleangetBlocked()Block the user for an indefinite period.StringgetCode()StringgetEmail()LocalDateTimegetExpiresOn()Disable the user from the specified date.BooleangetForcePasswordChange()Force the user to change their password at next login.GroupgetGroup()StringgetHomeAction()LonggetId()byte[]getImage()Max size 4MB.StringgetLanguage()Set<MetaPermission>getMetaPermissions()StringgetName()BooleangetNoHelp()Whether to show help messages.StringgetPassword()LocalDateTimegetPasswordUpdatedOn()Set<Permission>getPermissions()Set<Role>getRoles()BooleangetSingleTab()Whether to use tabbed ui.StringgetTheme()inthashCode()voidremoveMetaPermission(MetaPermission item)Remove the givenMetaPermissionitem from themetaPermissionscollection.voidremovePermission(Permission item)Remove the givenPermissionitem from thepermissionscollection.voidremoveRole(Role item)Remove the givenRoleitem from therolescollection.voidsetActivateOn(LocalDateTime activateOn)voidsetBlocked(Boolean blocked)voidsetCode(String code)voidsetEmail(String email)voidsetExpiresOn(LocalDateTime expiresOn)voidsetForcePasswordChange(Boolean forcePasswordChange)voidsetGroup(Group group)voidsetHomeAction(String homeAction)voidsetId(Long id)voidsetImage(byte[] image)voidsetLanguage(String language)voidsetMetaPermissions(Set<MetaPermission> metaPermissions)voidsetName(String name)voidsetNoHelp(Boolean noHelp)voidsetPassword(String password)voidsetPasswordUpdatedOn(LocalDateTime passwordUpdatedOn)voidsetPermissions(Set<Permission> permissions)voidsetRoles(Set<Role> roles)voidsetSingleTab(Boolean singleTab)voidsetTheme(String theme)StringtoString()-
Methods inherited from class com.axelor.auth.db.AuditableModel
getCreatedBy, getCreatedOn, getUpdatedBy, getUpdatedOn
-
Methods inherited from class com.axelor.db.Model
getArchived, getCid, getVersion, isSelected, setArchived, setCid, setSelected, setVersion
-
-
-
-
Method Detail
-
getCode
public String getCode()
-
setCode
public void setCode(String code)
-
getName
public String getName()
-
setName
public void setName(String name)
-
getPassword
public String getPassword()
-
setPassword
public void setPassword(String password)
-
getPasswordUpdatedOn
public LocalDateTime getPasswordUpdatedOn()
-
setPasswordUpdatedOn
public void setPasswordUpdatedOn(LocalDateTime passwordUpdatedOn)
-
getForcePasswordChange
public Boolean getForcePasswordChange()
Force the user to change their password at next login.- Returns:
- the property value
-
setForcePasswordChange
public void setForcePasswordChange(Boolean forcePasswordChange)
-
getImage
public byte[] getImage()
Max size 4MB.- Returns:
- the property value
-
setImage
public void setImage(byte[] image)
-
getEmail
public String getEmail()
-
setEmail
public void setEmail(String email)
-
getLanguage
public String getLanguage()
-
setLanguage
public void setLanguage(String language)
-
getHomeAction
public String getHomeAction()
-
setHomeAction
public void setHomeAction(String homeAction)
-
getTheme
public String getTheme()
-
setTheme
public void setTheme(String theme)
-
getSingleTab
public Boolean getSingleTab()
Whether to use tabbed ui.- Returns:
- the property value
-
setSingleTab
public void setSingleTab(Boolean singleTab)
-
getNoHelp
public Boolean getNoHelp()
Whether to show help messages.- Returns:
- the property value
-
setNoHelp
public void setNoHelp(Boolean noHelp)
-
getBlocked
public Boolean getBlocked()
Block the user for an indefinite period.- Returns:
- the property value
-
setBlocked
public void setBlocked(Boolean blocked)
-
getActivateOn
public LocalDateTime getActivateOn()
Activate the user from the specified date.- Returns:
- the property value
-
setActivateOn
public void setActivateOn(LocalDateTime activateOn)
-
getExpiresOn
public LocalDateTime getExpiresOn()
Disable the user from the specified date.- Returns:
- the property value
-
setExpiresOn
public void setExpiresOn(LocalDateTime expiresOn)
-
getGroup
public Group getGroup()
-
setGroup
public void setGroup(Group group)
-
addRole
public void addRole(Role item)
Add the givenRoleitem to therolescollection.- Parameters:
item- the item to add
-
removeRole
public void removeRole(Role item)
Remove the givenRoleitem from therolescollection.- Parameters:
item- the item to remove
-
clearRoles
public void clearRoles()
Clear therolescollection.
-
getPermissions
public Set<Permission> getPermissions()
-
setPermissions
public void setPermissions(Set<Permission> permissions)
-
addPermission
public void addPermission(Permission item)
Add the givenPermissionitem to thepermissionscollection.- Parameters:
item- the item to add
-
removePermission
public void removePermission(Permission item)
Remove the givenPermissionitem from thepermissionscollection.- Parameters:
item- the item to remove
-
clearPermissions
public void clearPermissions()
Clear thepermissionscollection.
-
getMetaPermissions
public Set<MetaPermission> getMetaPermissions()
-
setMetaPermissions
public void setMetaPermissions(Set<MetaPermission> metaPermissions)
-
addMetaPermission
public void addMetaPermission(MetaPermission item)
Add the givenMetaPermissionitem to themetaPermissionscollection.- Parameters:
item- the item to add
-
removeMetaPermission
public void removeMetaPermission(MetaPermission item)
Remove the givenMetaPermissionitem from themetaPermissionscollection.- Parameters:
item- the item to remove
-
clearMetaPermissions
public void clearMetaPermissions()
Clear themetaPermissionscollection.
-
-