org.dspace.eperson

Class EPerson

java.lang.Object

org.dspace.content.DSpaceObject

org.dspace.eperson.EPerson

All Implemented Interfaces:

Serializable, DSpaceObjectLegacySupport, ReloadableEntity<UUID>

@Entity
public class EPerson
extends DSpaceObject
implements DSpaceObjectLegacySupport

Class representing an e-person.

Version:

$Revision$

Author:

David Stuve

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	EMAIL The e-mail field (for sorting)
protected EPersonService	ePersonService
static int	ID The e-mail field (for sorting)
static int	LANGUAGE The e-mail field (for sorting)
static int	LASTNAME The last name (for sorting)
static int	NETID The netid field (for sorting)

Fields inherited from class org.dspace.content.DSpaceObject

id

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EPerson() Protected constructor, create object using: EPersonService.create(Context)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLogIn() Can the user log in?
boolean	equals(Object obj) Return true if this object equals obj, false otherwise.
String	getEmail() Get the e-person's email address
String	getFirstName() Get the eperson's first name.
String	getFullName() Get the e-person's full name, combining first and last name in a displayable string.
List<Group>	getGroups()
String	getLanguage() Get the e-person's language
Date	getLastActive() Get the EPerson's last-active stamp.
String	getLastName() Get the eperson's last name.
Integer	getLegacyId()
String	getName()
String	getNetid() Get the e-person's netid
boolean	getRequireCertificate() Get require certificate or not
boolean	getSelfRegistered() Is the user self-registered?
int	getType() return type found in Constants
int	hashCode() Return a hash code for this object.
void	setCanLogIn(boolean login) Indicate whether the user can log in
void	setEmail(String s) Set the EPerson's email
void	setFirstName(Context context, String firstname) Set the eperson's first name
void	setLanguage(Context context, String language) Set the EPerson's language.
void	setLastActive(Date when) Stamp the EPerson's last-active date.
void	setLastName(Context context, String lastname) Set the eperson's last name
void	setNetid(String netid) Set the EPerson's netid
void	setRequireCertificate(boolean isrequired) Set require cert yes/no
void	setSelfRegistered(boolean sr) Indicate whether the user self-registered

Methods inherited from class org.dspace.content.DSpaceObject

addDetails, addHandle, addMetadata, clearDetails, clearModified, getDetails, getHandle, getHandles, getID, getMetadata, getResourcePolicies, isMetadataModified, isModified, removeMetadata, removeMetadata, setMetadata, setMetadataModified, setModified

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMAIL

public static final int EMAIL

The e-mail field (for sorting)

See Also:

Constant Field Values

LASTNAME

public static final int LASTNAME

The last name (for sorting)

See Also:

Constant Field Values

ID

public static final int ID

The e-mail field (for sorting)

See Also:

Constant Field Values

NETID

public static final int NETID

The netid field (for sorting)

See Also:

Constant Field Values

LANGUAGE

public static final int LANGUAGE

The e-mail field (for sorting)

See Also:

Constant Field Values

ePersonService

protected transient EPersonService ePersonService

Constructor Detail

EPerson

protected EPerson()

Protected constructor, create object using: EPersonService.create(Context)

Method Detail

getLegacyId

public Integer getLegacyId()

Specified by:

getLegacyId in interface DSpaceObjectLegacySupport

Returns:

the old integer based legacy identifier

equals

public boolean equals(Object obj)

Return true if this object equals obj, false otherwise.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if ResourcePolicy objects are equal

hashCode

public int hashCode()

Return a hash code for this object.

Overrides:

hashCode in class Object

Returns:

int hash of object

getLanguage

public String getLanguage()

Get the e-person's language

Returns:

language code (or null if the column is an SQL NULL)

setLanguage

public void setLanguage(Context context,
               String language)
                 throws SQLException

Set the EPerson's language. Value is expected to be a Unix/POSIX Locale specification of the form {language} or {language}_{territory}, e.g. "en", "en_US", "pt_BR" (the latter is Brazilian Portugese).

Parameters:

language - language code

Throws:

SQLException

getEmail

public String getEmail()

Get the e-person's email address

Returns:

their email address (or null if the column is an SQL NULL)

setEmail

public void setEmail(String s)

Set the EPerson's email

Parameters:

s - the new email

getNetid

public String getNetid()

Get the e-person's netid

Returns:

their netid (DB constraints ensure it's never NULL)

setNetid

public void setNetid(String netid)

Set the EPerson's netid

Parameters:

netid - the new netid

getFullName

public String getFullName()

Get the e-person's full name, combining first and last name in a displayable string.

Returns:

their full name (first + last name; if both are NULL, returns email)

getFirstName

public String getFirstName()

Get the eperson's first name.

Returns:

their first name (or null if the column is an SQL NULL)

setFirstName

public void setFirstName(Context context,
                String firstname)
                  throws SQLException

Set the eperson's first name

Parameters:

firstname - the person's first name

Throws:

SQLException

getLastName

public String getLastName()

Get the eperson's last name.

Returns:

their last name (or null if the column is an SQL NULL)

setLastName

public void setLastName(Context context,
               String lastname)
                 throws SQLException

Set the eperson's last name

Parameters:

lastname - the person's last name

Throws:

SQLException

setCanLogIn

public void setCanLogIn(boolean login)

Indicate whether the user can log in

Parameters:

login - boolean yes/no

canLogIn

public boolean canLogIn()

Can the user log in?

Returns:

boolean, yes/no

setRequireCertificate

public void setRequireCertificate(boolean isrequired)

Set require cert yes/no

Parameters:

isrequired - boolean yes/no

getRequireCertificate

public boolean getRequireCertificate()

Get require certificate or not

Returns:

boolean, yes/no (or false if the column is an SQL NULL)

setSelfRegistered

public void setSelfRegistered(boolean sr)

Indicate whether the user self-registered

Parameters:

sr - boolean yes/no

getSelfRegistered

public boolean getSelfRegistered()

Is the user self-registered?

Returns:

boolean, yes/no (or false if the column is an SQL NULL)

setLastActive

public void setLastActive(Date when)

Stamp the EPerson's last-active date.

Parameters:

when - latest activity timestamp, or null to clear.

getLastActive

public Date getLastActive()

Get the EPerson's last-active stamp.

Returns:

date when last logged on, or null.

getType

public int getType()

return type found in Constants

Specified by:

getType in class DSpaceObject

Returns:

type of the object

getName

public String getName()

Specified by:

getName in class DSpaceObject

getGroups

public List<Group> getGroups()