lumis.portal.monitor

Interface IMonitorField

@StableMinor(version="10.3",
             sinceVersion="9.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: 20807 $ $Date: 2017-11-30 19:08:51 +0000 (Thu, 30 Nov 2017) $

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
IMonitorField	addInnerField(IMonitorField innerField) Adds the given inner field.
IMonitorField.DataType	getDataType() Returns this field data type.
String	getDescription() Returns the (localizable description).
String	getId() Returns the identifier of this field.
Collection<IMonitorField>	getInnerFields() Returns an unmodifiable collection of inner fields.
String	getName() Returns the (localizable) name of this field.
String	getStringResourcePath() Returns this field string resource path (used, if present, to localize strings).
String	getUnit() Returns the (localizable) unit of this field.
IMonitorField	setDataType(IMonitorField.DataType dataType) Sets this field data type.
IMonitorField	setDescription(String description) Sets the (localizable description).
IMonitorField	setName(String name) Sets the (localizable) name of this field.
IMonitorField	setStringResourcePath(String stringResourcePath) Sets this field string resource path (used, if present, to localize strings).
IMonitorField	setUnit(String unit) Sets the (localizable) unit of this field.

Method Detail

getId

String getId()

Returns the identifier of this field.

Returns:

the identifier of this field.

Since:

9.0.0

getName

String getName()

Returns the (localizable) name of this field.

Returns:

the (localizable) name of this field.

Since:

9.0.0

setName

IMonitorField 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

getDescription

String getDescription()

Returns the (localizable description).

Returns:

the (localizable description).

Since:

9.0.0

setDescription

IMonitorField setDescription(String description)

Sets the (localizable description).

Parameters:

description - the (localizable description).

Returns:

this field for chaining.

Since:

9.0.0

getUnit

String getUnit()

Returns the (localizable) unit of this field.

Returns:

the (localizable) unit of this field.

Since:

9.0.0

setUnit

IMonitorField 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

getStringResourcePath

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

setStringResourcePath

IMonitorField 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

getDataType

IMonitorField.DataType getDataType()

Returns this field data type.

Returns:

this field data type.

Since:

9.0.0

setDataType

IMonitorField setDataType(IMonitorField.DataType dataType)

Sets this field data type.

Parameters:

dataType - this field data type.

Returns:

this field for chaining.

Since:

9.0.0

getInnerFields

Collection<IMonitorField> getInnerFields()

Returns an unmodifiable collection of inner fields.

Returns:

an unmodifiable collection of inner fields.

Throws:

IllegalStateException - if this field is not a complex field.

Since:

10.2.0

addInnerField

IMonitorField 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