All Superinterfaces:

IMonitorElementSPI<IMonitorFieldSPI>, IMonitorField

All Known Implementing Classes:

MonitorField
```
public interface IMonitorFieldSPI
extends IMonitorField, IMonitorElementSPI<IMonitorFieldSPI>
```
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: 23941 $ $Date: 2020-06-29 16:08:50 -0300 (Mon, 29 Jun 2020) $

Nested Class Summary
- Nested classes/interfaces inherited from interface lumis.portal.monitor.IMonitorField
  IMonitorField.DataType

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IMonitorFieldSPI`	`addInnerField(IMonitorField innerField)`	Adds the given inner field.
`IMonitorFieldSPI`	`clearInnerFields()`	Removes all inner fields.
`Boolean`	`getIdentifiesUserOverride()`	Returns whether this field identifies the user and must have its value modified when anonymized according to configuration of the current environment.
`IMonitorField`	`getParent()`	Returns the parent field.
`boolean`	`isIdentifiesUserDefinition()`	Returns whether this field identifies the user and must have its value modified when anonymized according to the definition of this field.
`boolean`	`isStandard()`	Returns whether this is a standard field.
`IMonitorFieldSPI`	`removeInnerField(String innerFieldId)`	Removes the given inner field.
`IMonitorFieldSPI`	`setDataType(IMonitorField.DataType dataType)`	Sets the data type for this field.
`IMonitorFieldSPI`	`setDescription(String description)`	Sets the (localizable description).
`IMonitorFieldSPI`	`setIdentifiesUserDefinition(boolean identifiesUserDefinition)`	Sets whether this field identifies the user and must have its value modified when anonymized according to the definition of this field.
`IMonitorFieldSPI`	`setIdentifiesUserOverride(Boolean identifiesUserOverride)`	Sets whether this field identifies the user and must have its value modified when anonymized, according to configuration of the current environment.
`IMonitorFieldSPI`	`setName(String name)`	Sets the (localizable) name of this field.
`IMonitorFieldSPI`	`setStandard(boolean isStandard)`	Sets this field either as standard or custom (non-standard).
`IMonitorFieldSPI`	`setStringResourcePath(String stringResourcePath)`	Sets this field string resource path (used, if present, to localize strings).
`IMonitorFieldSPI`	`setUnit(String unit)`	Sets the (localizable) unit of this field.

Methods inherited from interface lumis.portal.monitor.IMonitorElementSPI
getId, getServiceInstanceId

Methods inherited from interface lumis.portal.monitor.IMonitorField
getDataType, getDescription, getId, getInnerFields, getLocalizedDescription, getLocalizedName, getLocalizedUnit, getName, getStringResourcePath, getUnit, identifiesUser

- Method Detail
  - setName
```
IMonitorFieldSPI setName(String name)
```
    Sets the (localizable) name of this field.
    
    Parameters:
    
    name - the (localizable) name of this field.
    
    Returns:
    
    this field for chaining.
    
    Since:
    
    9.0.0
  - setDescription
```
IMonitorFieldSPI setDescription(String description)
```
    Sets the (localizable description).
    
    Parameters:
    
    description - the (localizable description).
    
    Returns:
    
    this field for chaining.
    
    Since:
    
    9.0.0
  - setUnit
```
IMonitorFieldSPI setUnit(String unit)
```
    Sets the (localizable) unit of this field.
    
    Parameters:
    
    unit - the (localizable) unit of this field.
    
    Returns:
    
    this field for chaining.
    
    Since:
    
    9.0.0
  - setStringResourcePath
```
IMonitorFieldSPI setStringResourcePath(String stringResourcePath)
```
    Sets this field string resource path (used, if present, to localize strings).
    
    Parameters:
    
    stringResourcePath - this field string resource path (used, if present, to localize strings).
    
    Returns:
    
    this field for chaining.
    
    Since:
    
    9.0.0
  - addInnerField
```
IMonitorFieldSPI addInnerField(IMonitorField innerField)
```
    Adds the given inner field.
    
    Parameters:
    
    innerField - the inner field.
    
    Returns:
    
    this field.
    
    Throws:
    
    IllegalStateException - if this field is not a complex field.
    
    IllegalArgumentException - if the given inner field's identifier does not start with this field's identifier.
    
    Since:
    
    10.2.0
  - removeInnerField
```
IMonitorFieldSPI removeInnerField(String innerFieldId)
```
    Removes the given inner field.
    
    Parameters:
    
    innerFieldId - the inner field identifier.
    
    Returns:
    
    this field.
    
    Throws:
    
    IllegalStateException - if this field is not a complex field.
    
    Since:
    
    10.2.0
  - clearInnerFields
```
IMonitorFieldSPI clearInnerFields()
```
    Removes all inner fields.
    
    Returns:
    
    this field
    
    Since:
    
    11.0.0
  - setDataType
```
IMonitorFieldSPI setDataType(IMonitorField.DataType dataType)
```
    Sets the data type for this field.
    
    Parameters:
    
    dataType - the data type.
    
    Returns:
    
    this field.
    
    Throws:
    
    IllegalArgumentException - if the data type is changed.
    
    Since:
    
    10.2.0
  - setStandard
```
IMonitorFieldSPI setStandard(boolean isStandard)
```
    Sets this field either as standard or custom (non-standard).
    
    Parameters:
    
    isStandard - true to mark this field as standard, false to custom.
    
    Returns:
    
    this field for chaining.
    
    Since:
    
    11.0.0
  - isStandard
```
boolean isStandard()
```
    Returns whether this is a standard field.
    
    Returns:
    
    whether this is a standard field.
    
    Since:
    
    11.0.0
  - getParent
```
IMonitorField getParent()
```
    Returns the parent field.
    
    Returns:
    
    the parent field.
    
    Since:
    
    11.0.0
  - setIdentifiesUserOverride
```
IMonitorFieldSPI setIdentifiesUserOverride(Boolean identifiesUserOverride)
```
    Sets whether this field identifies the user and must have its value modified when anonymized, according to configuration of the current environment.
    
    Parameters:
    
    identifiesUserDefinition - true if the field was set as identifies user in the current configurations, false if set as does not identify user in the current configurations, or null if there is nothing explicit in the current configuration and it must use the definition default.
    
    Since:
    
    12.3.0
  - getIdentifiesUserOverride
```
Boolean getIdentifiesUserOverride()
```
    Returns whether this field identifies the user and must have its value modified when anonymized according to configuration of the current environment.
    
    Returns:
    
    true if the field was set as identifies user in the current configurations, false if set as does not identify user in the current configurations, or null if there is nothing explicit in the current configuration and it must use the definition default.
    
    Since:
    
    12.3.0
  - setIdentifiesUserDefinition
```
IMonitorFieldSPI setIdentifiesUserDefinition(boolean identifiesUserDefinition)
```
    Sets whether this field identifies the user and must have its value modified when anonymized according to the definition of this field.
    
    Parameters:
    
    anonymousDefinition - true if the definition of this field declares it as identifies user, false otherwise.
    
    Since:
    
    12.3.0
  - isIdentifiesUserDefinition
```
boolean isIdentifiesUserDefinition()
```
    Returns whether this field identifies the user and must have its value modified when anonymized according to the definition of this field.
    
    Returns:
    
    true if the definition of this field declares it as identifies user, false otherwise.
    
    Since:
    
    12.3.0

Interface IMonitorFieldSPI

Nested Class Summary

Nested classes/interfaces inherited from interface lumis.portal.monitor.IMonitorField

Method Summary

Methods inherited from interface lumis.portal.monitor.IMonitorElementSPI

Methods inherited from interface lumis.portal.monitor.IMonitorField

Method Detail

setName

setDescription

setUnit

setStringResourcePath

addInnerField

removeInnerField

clearInnerFields

setDataType

setStandard

isStandard

getParent

setIdentifiesUserOverride

getIdentifiesUserOverride

setIdentifiesUserDefinition

isIdentifiesUserDefinition