lumis.portal.monitor.impl

Class MonitorUser

java.lang.Object

lumis.portal.monitor.impl.MonitorUser

public class MonitorUser
extends Object

A monitored user.

Since:

11.0.0

Version:

$Revision: 23035 $ $Date: 2019-08-05 19:55:10 +0000 (Mon, 05 Aug 2019) $

Constructor Summary

Constructors

Constructor and Description
MonitorUser(String id) Creates a new monitor user with the specified identifier.
MonitorUser(String id, String trackId) Creates a new monitor user with the specified identifier and track identifier.

Method Summary

Modifier and Type	Method and Description
static MonitorUser	find(String monitorUserId) Returns the monitor user that corresponds to the given identifier.
static MonitorUser	findByTrackId(String trackId) Return the monitor user by its track identifier if it exists.
static MonitorUser	findMonitorUserByFriendlyId(String friendlyId) Return monitor user by its friendly identifier if it exists.
static MonitorUser	findMonitorUserByVisitorId(long visitorId) Return monitor user by its visitor identifier if it exists.
Date	getCreatedDateTime() Returns the date-time this user was created.
Map<String,List<Object>>	getCustomAttributes() Returns a persistent Map with the values of custom attributes of this user.
String	getEmail() Returns the email of this user.
String	getFirstName() Returns the first name of this user.
String	getFriendlyId() Returns the friendly identifier of this user.
String	getFullName() Returns the full name of this user.
String	getId() Returns the identifier of this user.
String	getLastName() Returns the last name of this user.
String	getMiddleName() Returns the middle name of this user.
String	getTrackId() Returns the track identifier of this monitor user.
long	getVisitorId() Returns a auto-increment identifier that offers a simpler way to differentiate visitors.
void	setEmail(String email) Sets the email of this user.
void	setFirstName(String firstName) Sets the first name of this user.
void	setFriendlyId(String friendlyId) Sets the friendly identifier of this user.
void	setLastName(String lastName) Sets the last name of this user.
void	setMiddleName(String middleName) Sets the middle name of this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorUser

public MonitorUser(String id,
                   String trackId)

Creates a new monitor user with the specified identifier and track identifier.

Parameters:

id - the identifier.

trackId - the track identifier.

Since:

12.0.0

MonitorUser

public MonitorUser(String id)

Creates a new monitor user with the specified identifier.

Parameters:

id - the identifier.

Since:

11.0.0

Method Detail

getId

public String getId()

Returns the identifier of this user.

Returns:

the identifier.

Since:

11.0.0

getTrackId

public String getTrackId()

Returns the track identifier of this monitor user.

Returns:

the track identifier.

Since:

12.0.0

getVisitorId

public long getVisitorId()

Returns a auto-increment identifier that offers a simpler way to differentiate visitors.

Returns:

the auto-increment identifier.

Throws:

NullPointerException - if the value for this field is not available. This may happen if this method is called on a entity that was not read from the database.

Since:

11.0.0

getCreatedDateTime

public Date getCreatedDateTime()

Returns the date-time this user was created.

Returns:

the date-time this user was created.

Since:

11.0.0

getFriendlyId

public String getFriendlyId()

Returns the friendly identifier of this user.

Returns:

the friendly identifier of this user or null if it is not set.

Since:

11.0.0

setFriendlyId

public void setFriendlyId(String friendlyId)

Sets the friendly identifier of this user.

Parameters:

friendlyId - the friendly identifier.

Since:

11.0.0

getFirstName

public String getFirstName()

Returns the first name of this user.

Returns:

the first name of this user or null if it is not set.

Since:

11.0.0

setFirstName

public void setFirstName(String firstName)

Sets the first name of this user.

Parameters:

firstName - the first name.

Since:

11.0.0

getMiddleName

public String getMiddleName()

Returns the middle name of this user.

Returns:

the middle name of this user or null if it is not set.

Since:

11.0.0

setMiddleName

public void setMiddleName(String middleName)

Sets the middle name of this user.

Parameters:

middleName - the middle name.

Since:

11.0.0

getLastName

public String getLastName()

Returns the last name of this user.

Returns:

the last name of this user or null if it is not set.

Since:

11.0.0

setLastName

public void setLastName(String lastName)

Sets the last name of this user.

Parameters:

lastName - the last name.

Since:

11.0.0

getEmail

public String getEmail()

Returns the email of this user.

Returns:

the email of this user or null if it is not set.

Since:

11.0.0

setEmail

public void setEmail(String email)

Sets the email of this user.

Parameters:

email - the email.

Since:

11.0.0

getCustomAttributes

public Map<String,List<Object>> getCustomAttributes()

Returns a persistent Map with the values of custom attributes of this user. The key of the map is the attribute identifier and the value of the map is the attribute values, with a type that corresponds to the attribute data type.

Returns:

a persistent Map with the values of custom attributes of this user.

Since:

12.0.0

getFullName

public String getFullName()

Returns the full name of this user. It is calculated from the getFirstName(), getMiddleName() and getLastName().

Returns:

the full name of this user.

Since:

11.0.0

find

public static MonitorUser find(String monitorUserId)

Returns the monitor user that corresponds to the given identifier. Uses information of monitor user identifier mappings to find the corresponding monitor user if necessary.

This method is intended to be used as a replacement of entityManager.find(MonitorUser.class, monitorUserId) when monitor user identifier mapping is to be taken into account.

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the monitor user, or null if no monitor user corresponds to the given identifier.

Since:

11.0.0

findMonitorUserByFriendlyId

public static MonitorUser findMonitorUserByFriendlyId(String friendlyId)

Return monitor user by its friendly identifier if it exists.

Parameters:

friendlyId - the friendly identifier.

Returns:

A monitor user.

Since:

11.0.0

findMonitorUserByVisitorId

public static MonitorUser findMonitorUserByVisitorId(long visitorId)

Return monitor user by its visitor identifier if it exists.

Parameters:

visitorId - the visitor identifier.

Returns:

A monitor user.

Since:

12.0.0

findByTrackId

public static MonitorUser findByTrackId(String trackId)

Return the monitor user by its track identifier if it exists.

Parameters:

trackId - the track identifier.

Returns:

the user, or null if no user with the given track identifier was found.

Since:

12.0.0