lumis.portal.user

Class UserAttribute

java.lang.Object

lumis.portal.user.UserAttribute

public class UserAttribute
extends Object

Entity that defines attributes that may be stored on users.

Since:

11.0.0

Version:

$Revision: 23745 $ $Date: 2020-04-07 23:09:15 +0000 (Tue, 07 Apr 2020) $

Constructor Summary

Constructors

Constructor and Description
UserAttribute(String id, IMonitorField.DataType dataType) Creates a new user attribute.

Method Summary

Modifier and Type	Method and Description
IMonitorField.DataType	getDataType() Returns the data type of this attribute.
String	getId() Returns the identifier of this user attribute.
String	getLabel() Returns the label of this attribute (yet to be localized using getStringResourcePath()).
String	getLocalizedLabel() Returns the result of localizing getLabel() using getStringResourcePath() using the current session's locale.
String	getStringResourcePath() Returns the string resource path used for localizing the attribute label.
boolean	identifyUser() Returns the identifyUser.
boolean	isFromModule() Returns whether this attribute is defined in a module.
void	setFromModule(boolean fromModule) Sets whether this attribute is defined in a module.
void	setIdentifyUser(boolean identifyUser) Sets the identifyUser.
void	setLabel(String label) Sets the label for this attribute.
void	setStringResourcePath(String stringResourcePath) Sets the string resource path used for localizing the attribute label.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAttribute

public UserAttribute(String id,
                     IMonitorField.DataType dataType)

Creates a new user attribute.

Parameters:

id - the attribute identifier.

dataType - the attribute data type.

Since:

11.0.0

Method Detail

getId

public String getId()

Returns the identifier of this user attribute.

Returns:

the identifier of this user attribute.

Since:

11.0.0

getLabel

public String getLabel()

Returns the label of this attribute (yet to be localized using getStringResourcePath()).

Returns:

the label of this attribute.

Since:

11.0.0

See Also:

getLocalizedLabel()

getLocalizedLabel

public String getLocalizedLabel()

Returns the result of localizing getLabel() using getStringResourcePath() using the current session's locale.

Returns:

the localized label.

Since:

11.0.0

setLabel

public void setLabel(String label)

Sets the label for this attribute.

Parameters:

label - the label, that may be a localization key for getStringResourcePath().

Since:

11.0.0

getDataType

public IMonitorField.DataType getDataType()

Returns the data type of this attribute.

Returns:

the data type.

Since:

11.0.0

getStringResourcePath

public String getStringResourcePath()

Returns the string resource path used for localizing the attribute label.

Returns:

the string resource path.

Since:

11.0.0

setStringResourcePath

public void setStringResourcePath(String stringResourcePath)

Sets the string resource path used for localizing the attribute label.

Parameters:

stringResourcePath - the string resource path.

Since:

11.0.0

isFromModule

public boolean isFromModule()

Returns whether this attribute is defined in a module.

Returns:

true if this attribute is defined in a module, false otherwise.

Since:

11.0.0

setFromModule

public void setFromModule(boolean fromModule)

Sets whether this attribute is defined in a module.

Parameters:

fromModule - true if this attribute is defined in a module, false otherwise.

Since:

11.0.0

identifyUser

public boolean identifyUser()

Returns the identifyUser.

Returns:

the identifyUser

Since:

12.3.0

setIdentifyUser

public void setIdentifyUser(boolean identifyUser)

Sets the identifyUser.

Parameters:

identifyUser - the identifyUser value to set.

Since:

12.3.0