org.olat.core.id
Interface Identity

All Superinterfaces:
CreateInfo, Persistable, java.io.Serializable
All Known Implementing Classes:
IdentityImpl

public interface Identity
extends CreateInfo, Persistable

Initial Date: 24.04.2004

Author:
Mike Stock

Field Summary
static java.lang.Integer STATUS_ACTIV
          Identity has access to olat-system.
static java.lang.Integer STATUS_DELETED
          Identity is deleted and has no access to olat-system and is not visible (except administrators).
static java.lang.Integer STATUS_LOGIN_DENIED
          Identity can not login and will not be listed (only on login-denied list).
static java.lang.Integer STATUS_PERMANENT
          Identity has a permanent olat user account and will be never listen in user-deletion process.
static java.lang.Integer STATUS_VISIBLE_LIMIT
          Limit for visible identities, all identities with status < LIMIT will be listed in search etc.
 
Method Summary
 java.util.Date getLastLogin()
           
 java.lang.String getName()
           
 java.lang.Integer getStatus()
           
 User getUser()
           
 void setLastLogin(java.util.Date loginDate)
          Set a new last login date for the user.
 void setName(java.lang.String name)
           
 void setStatus(java.lang.Integer newStatus)
          Set new status (aktiv,deleted,permanent) of identity.
 
Methods inherited from interface org.olat.core.id.CreateInfo
getCreationDate
 
Methods inherited from interface org.olat.core.id.Persistable
equalsByPersistableKey, getKey
 

Field Detail

STATUS_PERMANENT

static final java.lang.Integer STATUS_PERMANENT
Identity has a permanent olat user account and will be never listen in user-deletion process.


STATUS_ACTIV

static final java.lang.Integer STATUS_ACTIV
Identity has access to olat-system.


STATUS_VISIBLE_LIMIT

static final java.lang.Integer STATUS_VISIBLE_LIMIT
Limit for visible identities, all identities with status < LIMIT will be listed in search etc.


STATUS_LOGIN_DENIED

static final java.lang.Integer STATUS_LOGIN_DENIED
Identity can not login and will not be listed (only on login-denied list).


STATUS_DELETED

static final java.lang.Integer STATUS_DELETED
Identity is deleted and has no access to olat-system and is not visible (except administrators).

Method Detail

getName

java.lang.String getName()
Returns:
The username, (login name, nickname..)

getUser

User getUser()
Returns:
The user object associated with this identity. The user encapsulates the user data (profile and preferences)

getLastLogin

java.util.Date getLastLogin()
Returns:
Last date when the user logged in.

setLastLogin

void setLastLogin(java.util.Date loginDate)
Set a new last login date for the user.

Parameters:
loginDate - New last-login date.

getStatus

java.lang.Integer getStatus()
Returns:
Current identity status

setStatus

void setStatus(java.lang.Integer newStatus)
Set new status (aktiv,deleted,permanent) of identity.

Parameters:
newStatus - New status

setName

void setName(java.lang.String name)