Package lumis.portal.monitor

Interface IMonitorEvent

All Known Subinterfaces:

IMonitorEventSPI

All Known Implementing Classes:

MonitorEvent

@StableMinor(version="17.0",
             sinceVersion="9.0")
public interface IMonitorEvent

An event that may be monitored. Its definition specifies what data is saved and how it is saved.

Since:

9.0.0

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

See Also:

lumis.portal.monitor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_EVENT_PREFIX	Default event prefix.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the description of this event.
java.util.Collection<IMonitorFieldInstance>	getFields()	Returns an unmodifiable collection of the fields that should be collected for this event.
java.lang.String	getId()	Returns the identifier for this event.
java.lang.String	getImage()	Returns the image.
java.lang.String	getLocalizedDescription()	Returns the localized description of this event.
java.lang.String	getLocalizedName()	Returns the localized name of this event.
java.lang.String	getLocalizedVerb()	Returns the localized verb of this event.
java.lang.String	getName()	Returns the name of this event.
java.lang.String	getStringResourcePath()	The string resource path for localizing this event's strings.
java.lang.String	getVerb()	Returns the verb.
boolean	isEnabled()	Returns if the monitoring for this event is enabled.

Field Detail

DEFAULT_EVENT_PREFIX

static final java.lang.String DEFAULT_EVENT_PREFIX

Default event prefix.

Since:

9.0.0]

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the identifier for this event.

Returns:

the identifier for this event.

Since:

9.0.0

getFields

java.util.Collection<IMonitorFieldInstance> getFields()

Returns an unmodifiable collection of the fields that should be collected for this event.

Returns:

an unmodifiable collection of the fields that should be collected for this event.

Since:

9.0.0

getDescription

java.lang.String getDescription()

Returns the description of this event. The description is localizable using getStringResourcePath().

Returns:

the description of this event.

Since:

9.0.0

getLocalizedDescription

java.lang.String getLocalizedDescription()

Returns the localized description of this event.

Returns:

the description of this event.

Since:

11.0.0

isEnabled

boolean isEnabled()

Returns if the monitoring for this event is enabled.

Returns:

true if enabled or false if disabled.

Since:

9.0.0

getName

java.lang.String getName()

Returns the name of this event. The name is localizable using getStringResourcePath().

Returns:

the name of this event.

Since:

9.0.0

getImage

java.lang.String getImage()

Returns the image.

Returns:

the image

Since:

11.0.0

getVerb

java.lang.String getVerb()

Returns the verb.

Returns:

the verb.

Since:

11.0.0

getLocalizedName

java.lang.String getLocalizedName()

Returns the localized name of this event.

Returns:

the name for this event.

Since:

11.0.0

getStringResourcePath

java.lang.String getStringResourcePath()

The string resource path for localizing this event's strings.

Returns:

the string resource path.

Since:

9.0.0

getLocalizedVerb

java.lang.String getLocalizedVerb()

Returns the localized verb of this event.

Returns:

the verb for this event.

Since:

11.0.0