Package com.groiss.org
Interface User
- All Superinterfaces:
Activatable
,Agent
,KeyValuePair<String,
,String> Persistent
,Principal
,Serializable
A user is a representation for a person registered for
working with the system
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final long
The oid of the user guest, used for public servlet methods.static final long
The oid of the inactive user nobody.static final long
The system administrator (oid).static final User
The sysadm userFields inherited from interface com.groiss.store.Persistent
emptyKeys
-
Method Summary
Modifier and TypeMethodDescriptionvoid
checkPassword
(String password) Check the password.boolean
boolean
Get the description.getEmail()
Get the email address.Get the first name.int
get the gender of this usergetId()
Get the id.Return the locale set for this user as string.getName()
Implemented for Principal interfaceGet the name suffix for this userGet the order attribute.boolean
Get the flag, if mail has been sent that password will expire in future defined with configuration parameterpasswdpolicy.days_warning_before
boolean
Get the salutation for this userGet the surname.getTelNr()
Get the phone number.getTitle()
Get the title.Get the locale of the uservoid
setCantChangePwd
(boolean val) void
setChangePwdNext
(boolean val) void
setDescription
(String description) void
void
setFirstName
(String firstName) void
setGender
(int gender) set the gender of this uservoid
void
void
setNameSuffix
(String nameSuffix) Set the name suffix for this uservoid
setOrderAttr
(String orderAttr) Set the order attribute for this uservoid
setPassword
(String password) Set the password for this uservoid
setPwdExpirationMailSent
(boolean val) Set the flag, if expiration warning mail has been sentvoid
setPwdNeverExpires
(boolean val) void
setSalutation
(String salutation) Set the salutation for this uservoid
setSurname
(String surname) void
void
A string representation suitable for lists.Methods inherited from interface com.groiss.store.Activatable
isActive, setActive
Methods inherited from interface com.groiss.store.Persistent
afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid
-
Field Details
-
SYSADM
static final long SYSADMThe system administrator (oid).- See Also:
-
SYSADM_USER
The sysadm user -
NOBODY
static final long NOBODYThe oid of the inactive user nobody.- See Also:
-
GUEST
static final long GUESTThe oid of the user guest, used for public servlet methods.- See Also:
-
GENDER_MALE
static final int GENDER_MALE- See Also:
-
GENDER_FEMALE
static final int GENDER_FEMALE- See Also:
-
GENDER_OTHER
static final int GENDER_OTHER- See Also:
-
GENDER_UNKNOWN
static final int GENDER_UNKNOWN- See Also:
-
-
Method Details
-
getId
String getId()Get the id. -
setId
-
getName
String getName()Implemented for Principal interface -
getTitle
String getTitle()Get the title.- Returns:
- the title of the user
-
setTitle
-
getFirstName
String getFirstName()Get the first name.- Returns:
- the first name
-
setFirstName
-
getSurname
String getSurname()Get the surname.- Returns:
- the surname
-
setSurname
-
getDescription
String getDescription()Get the description.- Returns:
- the description
-
setDescription
-
getTelNr
String getTelNr()Get the phone number.- Returns:
- the phone number as string
-
setTelNr
-
getEmail
String getEmail()Get the email address.- Returns:
- email address
-
setEmail
-
getUserLocale
Locale getUserLocale()Get the locale of the user- Returns:
- Locale object
-
toListString
String toListString()A string representation suitable for lists.- Specified by:
toListString
in interfacePersistent
- Returns:
- a string representation of this Object suitable for usage in lists
-
getLocale
String getLocale()Return the locale set for this user as string. -
setLocale
-
getCantChangePwd
boolean getCantChangePwd() -
setCantChangePwd
void setCantChangePwd(boolean val) -
getChangePwdNext
boolean getChangePwdNext() -
setChangePwdNext
void setChangePwdNext(boolean val) -
getPwdNeverExpires
boolean getPwdNeverExpires() -
setPassword
Set the password for this user- Parameters:
password
- the plain password
-
checkPassword
Check the password. Throws ApplicationException with number 122 if password doesn't match. -
setPwdNeverExpires
void setPwdNeverExpires(boolean val) -
getPwdExpirationMailSent
boolean getPwdExpirationMailSent()Get the flag, if mail has been sent that password will expire in future defined with configuration parameterpasswdpolicy.days_warning_before
- Returns:
true
, if mail has been sent; otherwisefalse
-
setPwdExpirationMailSent
void setPwdExpirationMailSent(boolean val) Set the flag, if expiration warning mail has been sent- Parameters:
val
- the boolean value for the flag
-
getSalutation
String getSalutation()Get the salutation for this user- Returns:
- the salutation
-
setSalutation
Set the salutation for this user- Parameters:
salutation
- the new salutation
-
getNameSuffix
String getNameSuffix()Get the name suffix for this user- Returns:
- the name suffix
-
setNameSuffix
Set the name suffix for this user- Parameters:
nameSuffix
- the new name suffix
-
setGender
void setGender(int gender) set the gender of this user- Parameters:
gender
-- 0-unkown
- 1-male
- 2-female
- 9-other
- See Also:
-
getGender
int getGender()get the gender of this user- Returns:
- 0-unkown
- 1-male
- 2-female
- 9-other
- See Also:
-
getOrderAttr
String getOrderAttr()Get the order attribute.- Returns:
- the order attribute
-
setOrderAttr
Set the order attribute for this user- Parameters:
orderAttr
- the new order attribute
-