Package lumis.portal.monitor

Interface IMonitorField

All Known Subinterfaces:

IMonitorFieldSPI

All Known Implementing Classes:

MonitorField

@StableMinor(version="16.0",
             sinceVersion="11.0")
public interface IMonitorField

A field of a monitoring event. This definition will be used to define a big data field where the data related will be saved.

Since:

9.0.0

Version:

$Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IMonitorField.DataType	The possible data type for an event field.

Method Summary

Modifier and Type	Method	Description
IMonitorField.DataType	getDataType()	Returns this field data type.
java.lang.String	getDescription()	Returns the (localizable description).
java.lang.String	getId()	Returns the identifier of this field.
java.util.Collection<IMonitorField>	getInnerFields()	Returns an unmodifiable collection of inner fields.
java.lang.String	getLocalizedDescription()	Returns the localized description of this field.
java.lang.String	getLocalizedName()	Returns the localized name of this field.
java.lang.String	getLocalizedUnit()	Returns the localized unit of this field.
java.lang.String	getName()	Returns the (localizable) name of this field.
java.lang.String	getStringResourcePath()	Returns this field string resource path (used, if present, to localize strings).
java.lang.String	getUnit()	Returns the (localizable) unit of this field.
boolean	identifiesUser()	Indicates whether this field identifies the user and must have its value modified when anonymized.

Method Detail

getId

java.lang.String getId()

Returns the identifier of this field.

Returns:

the identifier of this field.

Since:

9.0.0

getName

java.lang.String getName()

Returns the (localizable) name of this field.

Returns:

the (localizable) name of this field.

Since:

9.0.0

getLocalizedName

java.lang.String getLocalizedName()

Returns the localized name of this field.

Returns:

the name for this field.

Since:

11.0.0

getDescription

java.lang.String getDescription()

Returns the (localizable description).

Returns:

the (localizable description).

Since:

9.0.0

getLocalizedDescription

java.lang.String getLocalizedDescription()

Returns the localized description of this field.

Returns:

the description of this field.

Since:

11.0.0

getUnit

java.lang.String getUnit()

Returns the (localizable) unit of this field.

Returns:

the (localizable) unit of this field.

Since:

9.0.0

getLocalizedUnit

java.lang.String getLocalizedUnit()

Returns the localized unit of this field.

Returns:

the localized unit of this field.

Since:

11.0.0

getStringResourcePath

java.lang.String getStringResourcePath()

Returns this field string resource path (used, if present, to localize strings).

Returns:

this field string resource path (used, if present, to localize strings).

Since:

9.0.0

getDataType

IMonitorField.DataType getDataType()

Returns this field data type.

Returns:

this field data type.

Since:

9.0.0

getInnerFields

java.util.Collection<IMonitorField> getInnerFields()

Returns an unmodifiable collection of inner fields.

Returns:

an unmodifiable collection of inner fields.

Throws:

java.lang.IllegalStateException - if this field is not a complex field.

Since:

10.2.0

identifiesUser

boolean identifiesUser()

Indicates whether this field identifies the user and must have its value modified when anonymized.

Returns:

true if this field identifies the user, false otherwise.

Since:

12.3.0