public class UserData extends BasicData implements NameableData, RemovableData, SystemData, ExtendableData, RegisteredData
User
,
Developer documentation: User authenticationModifier and Type | Field and Description |
---|---|
private java.lang.String |
address |
private java.util.Set<UserClientSettingData> |
clientSettings |
private java.util.Map<ContextIndex,ContextData> |
contexts |
private java.util.Set<UserDefaultSettingData> |
defaultSettings |
private java.lang.String |
description |
private boolean |
disabled |
private java.lang.String |
email |
private java.util.Date |
entryDate |
private java.util.Date |
expirationDate |
private java.util.Map<java.lang.String,java.lang.Object> |
extendedProperties |
private java.lang.String |
externalId |
private java.lang.String |
fax |
private java.util.Set<GroupData> |
groups |
private DirectoryData |
homeDirectory |
private java.util.Set<ItemKeyData> |
itemKeys |
private java.lang.String |
login |
static int |
MAX_ADDRESS_LENGTH
The maximum length of the address that can be stored in the database.
|
static int |
MAX_EMAIL_LENGTH
The maximum length of the email address that can be stored in the database.
|
static int |
MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database.
|
static int |
MAX_FAX_LENGTH
The maximum length of the fax that can be stored in the database.
|
static int |
MAX_LOGIN_LENGTH
The maximum length of the login that can be stored in the database.
|
static int |
MAX_ORGANISATION_LENGTH
The maximum length of the organisation that can be stored in the database.
|
static int |
MAX_PHONE_LENGTH
The maximum length of the phone that can be stored in the database.
|
static int |
MAX_URL_LENGTH
The maximum length of the url that can be stored in the database.
|
private java.util.Set<MessageData> |
messages |
private boolean |
multiuserAccount |
private java.lang.String |
name |
private java.lang.String |
organisation |
private PasswordData |
password |
private java.lang.String |
phone |
private java.util.Set<ProjectData> |
projects |
private QuotaData |
quota |
private GroupData |
quotaGroup |
private boolean |
removed |
private java.util.Set<RoleData> |
roles |
private boolean |
sendMessagesAsEmail |
private java.util.Set<SessionData> |
sessions |
private java.lang.String |
systemId |
private java.lang.String |
url |
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
MAX_SYSTEM_ID_LENGTH
Constructor and Description |
---|
UserData() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAddress()
Get the address for the user, or null if unknown.
|
(package private) java.util.Set<UserClientSettingData> |
getClientSettings()
This is the inverse end.
|
java.util.Map<ContextIndex,ContextData> |
getContexts()
The saved contexts for the user.
|
(package private) java.util.Set<UserDefaultSettingData> |
getDefaultSettings()
This is the inverse end.
|
java.lang.String |
getDescription()
Get the description for the item.
|
java.lang.String |
getEmail()
Get the email address to the user, or null if unknown.
|
java.util.Date |
getEntryDate()
Get the date this item was added to the database.
|
java.util.Date |
getExpirationDate()
Get the expiration date for this user account, or null if no expiration date
is set.
|
java.lang.Object |
getExtended(java.lang.String name)
Get the value of an extended property.
|
java.lang.String |
getExternalId()
Get the external ID for the user account.
|
java.lang.String |
getFax()
Get the fax number to the user, or null if unknown.
|
(package private) java.util.Set<GroupData> |
getGroups()
This is the inverse end.
|
DirectoryData |
getHomeDirectory()
Get the home directory for this user.
|
int |
getId()
We must override this method because the id must be the same as the
id for the password.
|
(package private) java.util.Set<ItemKeyData> |
getItemKeys()
This is the inverse end.
|
java.lang.String |
getLogin()
Get the login for the user account.
|
(package private) java.util.Set<MessageData> |
getMessages()
This is the inverse end.
|
java.lang.String |
getName()
Get the name of the item.
|
java.lang.String |
getOrganisation()
Get the organisation this user works for, or null if unknown.
|
PasswordData |
getPassword()
Get the
PasswordData object which allows you to change the
password for the user. |
java.lang.String |
getPhone()
Get the phone number to the user, or null if unknown.
|
(package private) java.util.Set<ProjectData> |
getProjects()
This is the inverse end.
|
QuotaData |
getQuota()
Get the quota object which holds quota information for this user.
|
GroupData |
getQuotaGroup()
Get the group this user is sharing quota with, or null if this user only
has it's own quota.
|
(package private) java.util.Set<RoleData> |
getRoles()
This is the inverse end.
|
boolean |
getSendMessagesAsEmail()
If this flag is set, all messages to this user are sent as an email
also, but only if: the server admin has configured an outgoing smtp
server and the user has supplied a valid email address.
|
(package private) java.util.Set<SessionData> |
getSessions()
This is the inverse end.
|
java.lang.String |
getSystemId()
Get the system id for the item.
|
java.lang.String |
getUrl()
Get the URL to the user's homepage, or null if unknown.
|
boolean |
isDisabled()
Check if this account is disabled or enabled.
|
boolean |
isMultiuserAccount()
Check if this account has enabled the multiuser feature.
|
boolean |
isRemoved()
Check if the removed flag is set for this item.
|
void |
setAddress(java.lang.String address) |
(package private) void |
setClientSettings(java.util.Set<UserClientSettingData> clientSettings) |
(package private) void |
setContexts(java.util.Map<ContextIndex,ContextData> contexts) |
(package private) void |
setDefaultSettings(java.util.Set<UserDefaultSettingData> defaultSettings) |
void |
setDescription(java.lang.String description)
Set the description for the item.
|
void |
setDisabled(boolean disabled) |
void |
setEmail(java.lang.String email) |
void |
setEntryDate(java.util.Date entryDate) |
void |
setExpirationDate(java.util.Date expirationDate) |
void |
setExtended(java.lang.String name,
java.lang.Object value)
Set the value of an extended property.
|
void |
setExternalId(java.lang.String externalId) |
void |
setFax(java.lang.String fax) |
(package private) void |
setGroups(java.util.Set<GroupData> groups) |
void |
setHomeDirectory(DirectoryData homeDirectory) |
(package private) void |
setItemKeys(java.util.Set<ItemKeyData> itemKeys) |
void |
setLogin(java.lang.String login) |
(package private) void |
setMessages(java.util.Set<MessageData> messages) |
void |
setMultiuserAccount(boolean multiuserAccount) |
void |
setName(java.lang.String name)
Set the name of the item.
|
void |
setOrganisation(java.lang.String organisation) |
(package private) void |
setPassword(PasswordData password) |
void |
setPhone(java.lang.String phone) |
(package private) void |
setProjects(java.util.Set<ProjectData> projects) |
void |
setQuota(QuotaData quota) |
void |
setQuotaGroup(GroupData quotaGroup) |
void |
setRemoved(boolean removed)
Set the removed flag for this item.
|
(package private) void |
setRoles(java.util.Set<RoleData> roles) |
void |
setSendMessagesAsEmail(boolean sendMessagesAsEmail) |
(package private) void |
setSessions(java.util.Set<SessionData> sessions) |
void |
setSystemId(java.lang.String systemId) |
void |
setUrl(java.lang.String url) |
equals, getVersion, hashCode, setId, setVersion, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getVersion
private java.lang.String name
private java.lang.String description
private boolean removed
private java.lang.String systemId
private java.util.Map<java.lang.String,java.lang.Object> extendedProperties
private java.util.Date entryDate
private PasswordData password
private boolean multiuserAccount
private java.util.Date expirationDate
private boolean disabled
public static final int MAX_EXTERNAL_ID_LENGTH
setExternalId(String)
,
Constant Field Valuesprivate java.lang.String externalId
public static final int MAX_LOGIN_LENGTH
setExternalId(String)
,
Constant Field Valuesprivate java.lang.String login
public static final int MAX_ORGANISATION_LENGTH
setOrganisation(String)
,
Constant Field Valuesprivate java.lang.String organisation
public static final int MAX_ADDRESS_LENGTH
setAddress(String)
,
Constant Field Valuesprivate java.lang.String address
public static final int MAX_PHONE_LENGTH
setPhone(String)
,
Constant Field Valuesprivate java.lang.String phone
public static final int MAX_FAX_LENGTH
setFax(String)
,
Constant Field Valuesprivate java.lang.String fax
public static final int MAX_EMAIL_LENGTH
setEmail(String)
,
Constant Field Valuesprivate java.lang.String email
private boolean sendMessagesAsEmail
public static final int MAX_URL_LENGTH
setUrl(String)
,
Constant Field Valuesprivate java.lang.String url
private GroupData quotaGroup
private QuotaData quota
private DirectoryData homeDirectory
private java.util.Set<GroupData> groups
private java.util.Set<RoleData> roles
private java.util.Set<ProjectData> projects
private java.util.Set<ItemKeyData> itemKeys
private java.util.Set<SessionData> sessions
private java.util.Set<UserClientSettingData> clientSettings
private java.util.Set<UserDefaultSettingData> defaultSettings
private java.util.Set<MessageData> messages
private java.util.Map<ContextIndex,ContextData> contexts
public int getId()
getId
in interface IdentifiableData
getId
in class BasicData
public java.lang.String getName()
NameableData
getName
in interface NameableData
String
with the name of the itempublic void setName(java.lang.String name)
NameableData
MAX_NAME_LENGTH
constant.setName
in interface NameableData
name
- The new name for the itempublic java.lang.String getDescription()
NameableData
getDescription
in interface NameableData
String
with a description of the itempublic void setDescription(java.lang.String description)
NameableData
MAX_DESCRIPTION_LENGTH
constant.setDescription
in interface NameableData
description
- The new description for the itempublic boolean isRemoved()
RemovableData
isRemoved
in interface RemovableData
public void setRemoved(boolean removed)
RemovableData
setRemoved
in interface RemovableData
removed
- TRUE if the item should be flagged as removed,
FALSE otherwisepublic java.lang.String getSystemId()
SystemData
getSystemId
in interface SystemData
public void setSystemId(java.lang.String systemId)
public java.lang.Object getExtended(java.lang.String name)
ExtendableData
getExtended
in interface ExtendableData
name
- The name of the propertypublic void setExtended(java.lang.String name, java.lang.Object value)
ExtendableData
setExtended
in interface ExtendableData
name
- The name of the propertyvalue
- The new value for the propertypublic java.util.Date getEntryDate()
RegisteredData
getEntryDate
in interface RegisteredData
public void setEntryDate(java.util.Date entryDate)
@PropertyPathProtected public PasswordData getPassword()
PasswordData
object which allows you to change the
password for the user. This is never null and is automatically
deleted when the user a user is deleted.void setPassword(PasswordData password)
public boolean isMultiuserAccount()
public void setMultiuserAccount(boolean multiuserAccount)
public java.util.Date getExpirationDate()
return new Date(userdata.getExpirationDate());
public void setExpirationDate(java.util.Date expirationDate)
public boolean isDisabled()
public void setDisabled(boolean disabled)
public java.lang.String getExternalId()
public void setExternalId(java.lang.String externalId)
public java.lang.String getLogin()
public void setLogin(java.lang.String login)
public java.lang.String getOrganisation()
public void setOrganisation(java.lang.String organisation)
public java.lang.String getAddress()
public void setAddress(java.lang.String address)
public java.lang.String getPhone()
public void setPhone(java.lang.String phone)
public java.lang.String getFax()
public void setFax(java.lang.String fax)
public java.lang.String getEmail()
public void setEmail(java.lang.String email)
public boolean getSendMessagesAsEmail()
public void setSendMessagesAsEmail(boolean sendMessagesAsEmail)
public java.lang.String getUrl()
public void setUrl(java.lang.String url)
public GroupData getQuotaGroup()
getQuota()
public void setQuotaGroup(GroupData quotaGroup)
public QuotaData getQuota()
getQuotaGroup()
public void setQuota(QuotaData quota)
public DirectoryData getHomeDirectory()
getQuota()
public void setHomeDirectory(DirectoryData homeDirectory)
java.util.Set<GroupData> getGroups()
GroupData.getUsers()
void setGroups(java.util.Set<GroupData> groups)
java.util.Set<RoleData> getRoles()
RoleData.getUsers()
void setRoles(java.util.Set<RoleData> roles)
java.util.Set<ProjectData> getProjects()
ProjectData.getUsers()
void setProjects(java.util.Set<ProjectData> projects)
java.util.Set<ItemKeyData> getItemKeys()
ItemKeyData.getUsers()
void setItemKeys(java.util.Set<ItemKeyData> itemKeys)
java.util.Set<SessionData> getSessions()
SessionData.getUser()
void setSessions(java.util.Set<SessionData> sessions)
java.util.Set<UserClientSettingData> getClientSettings()
UserClientSettingData.getUser()
void setClientSettings(java.util.Set<UserClientSettingData> clientSettings)
java.util.Set<UserDefaultSettingData> getDefaultSettings()
UserDefaultSettingData.getUser()
void setDefaultSettings(java.util.Set<UserDefaultSettingData> defaultSettings)
java.util.Set<MessageData> getMessages()
MessageData.getTo()
void setMessages(java.util.Set<MessageData> messages)
public java.util.Map<ContextIndex,ContextData> getContexts()
ContextData.getUser()
void setContexts(java.util.Map<ContextIndex,ContextData> contexts)