com.groiss.org

Interface User

All Superinterfaces:

Activatable, Agent, KeyValuePair<String,String>, Persistent, Principal, Serializable

public interface User
extends Agent, Principal

A user is a representation for a person registered for working with the system

Field Summary

Fields

Modifier and Type	Field and Description
static int	GENDER_FEMALE
static int	GENDER_MALE
static int	GENDER_OTHER
static int	GENDER_UNKNOWN
static long	GUEST The oid of the user guest, used for public servlet methods.
static long	NOBODY The oid of the inactive user nobody.
static long	SYSADM The system administrator (oid).
static User	SYSADM_USER The sysadm user

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method and Description
void	checkPassword(String password) Check the password.
boolean	getCantChangePwd()
boolean	getChangePwdNext()
String	getDescription() Get the description.
String	getEmail() Get the email address.
String	getFirstName() Get the first name.
int	getGender() get the gender of this user
String	getId() Get the id.
String	getLocale() Return the locale set for this user as string.
String	getName() Implemented for Principal interface
String	getNameSuffix() Get the name suffix for this user
String	getOrderAttr() Get the order attribute.
boolean	getPwdExpirationMailSent() Get the flag, if mail has been sent that password will expire in future defined with configuration parameter passwdpolicy.days_warning_before
boolean	getPwdNeverExpires()
String	getSalutation() Get the salutation for this user
String	getSurname() Get the surname.
String	getTelNr() Get the phone number.
String	getTitle() Get the title.
Locale	getUserLocale() Get the locale of the user
void	setCantChangePwd(boolean val)
void	setChangePwdNext(boolean val)
void	setDescription(String description)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setGender(int gender) set the gender of this user
void	setId(String id)
void	setLocale(String locale)
void	setNameSuffix(String nameSuffix) Set the name suffix for this user
void	setOrderAttr(String orderAttr) Set the order attribute for this user
void	setPassword(String password) Set the password for this user
void	setPwdExpirationMailSent(boolean val) Set the flag, if expiration warning mail has been sent
void	setPwdNeverExpires(boolean val)
void	setSalutation(String salutation) Set the salutation for this user
void	setSurname(String surname)
void	setTelNr(String telNr)
void	setTitle(String title)
String	toListString() A string representation suitable for lists.

Methods inherited from interface com.groiss.org.Agent

getOid

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, setStore

Methods inherited from interface com.groiss.store.Activatable

isActive, setActive

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Field Detail

SYSADM

static final long SYSADM

The system administrator (oid).

See Also:

Constant Field Values

SYSADM_USER

static final User SYSADM_USER

The sysadm user

NOBODY

static final long NOBODY

The oid of the inactive user nobody.

See Also:

Constant Field Values

GUEST

static final long GUEST

The oid of the user guest, used for public servlet methods.

See Also:

Constant Field Values

GENDER_MALE

static final int GENDER_MALE

See Also:

getGender(), setGender(int), Constant Field Values

GENDER_FEMALE

static final int GENDER_FEMALE

See Also:

getGender(), setGender(int), Constant Field Values

GENDER_OTHER

static final int GENDER_OTHER

See Also:

getGender(), setGender(int), Constant Field Values

GENDER_UNKNOWN

static final int GENDER_UNKNOWN

See Also:

getGender(), setGender(int), Constant Field Values

Method Detail

getId

String getId()

Get the id.

Specified by:

getId in interface Agent

Returns:

the id

setId

void setId(String id)

getName

String getName()

Implemented for Principal interface

Specified by:

getName in interface Principal

getTitle

String getTitle()

Get the title.

Returns:

the title of the user

setTitle

void setTitle(String title)

getFirstName

String getFirstName()

Get the first name.

Returns:

the first name

setFirstName

void setFirstName(String firstName)

getSurname

String getSurname()

Get the surname.

Returns:

the surname

setSurname

void setSurname(String surname)

getDescription

String getDescription()

Get the description.

Returns:

the description

setDescription

void setDescription(String description)

getTelNr

String getTelNr()

Get the phone number.

Returns:

the phone number as string

setTelNr

void setTelNr(String telNr)

getEmail

String getEmail()

Get the email address.

Returns:

email address

setEmail

void setEmail(String email)

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 interface Persistent

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

void setLocale(String locale)

getCantChangePwd

boolean getCantChangePwd()

setCantChangePwd

void setCantChangePwd(boolean val)

getChangePwdNext

boolean getChangePwdNext()

setChangePwdNext

void setChangePwdNext(boolean val)

getPwdNeverExpires

boolean getPwdNeverExpires()

setPassword

void setPassword(String password)

Set the password for this user

Parameters:

password - the plain password

checkPassword

void checkPassword(String password)

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 parameter passwdpolicy.days_warning_before

Returns:

true, if mail has been sent; otherwise false

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

void setSalutation(String salutation)

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

void setNameSuffix(String nameSuffix)

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:

GENDER_FEMALE, GENDER_MALE, GENDER_OTHER, GENDER_UNKNOWN

getGender

int getGender()

get the gender of this user

Returns:

• 0-unkown
• 1-male
• 2-female
• 9-other

See Also:

GENDER_FEMALE, GENDER_MALE, GENDER_OTHER, GENDER_UNKNOWN

getOrderAttr

String getOrderAttr()

Get the order attribute.

Returns:

the order attribute

setOrderAttr

void setOrderAttr(String orderAttr)

Set the order attribute for this user

Parameters:

orderAttr - the new order attribute