lumis.portal.monitor

Interface IMonitorEvent

@StableMinor(version="10.1",
             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: 19961 $ $Date: 2017-02-21 21:39:20 +0000 (Tue, 21 Feb 2017) $

See Also:

lumis.portal.monitor

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
IMonitorEvent	addField(IMonitorField field, boolean required) Adds the given field in this event.
String	getDescription() Returns the description for this event.
Collection<IMonitorEventField>	getFields() Returns the fields of this event.
String	getId() Returns the identifier for this event.
String	getName() Returns the name for this event.
String	getStringResourcePath() The string resource path for localizing this event's strings.
boolean	isEnabled() Returns if the monitoring for this event is enabled.
IMonitorEvent	setDescription(String description) Sets the description for this event.
IMonitorEvent	setEnabled(boolean enabled) Enables or disables the monitoring of this event.
IMonitorEvent	setName(String name) Sets the name for this event.
IMonitorEvent	setStringResourcePath(String stringResourcePath) Sets the string resource path for this event.

Field Detail

DEFAULT_EVENT_PREFIX

static final String DEFAULT_EVENT_PREFIX

Default event prefix.

Since:

9.0.0]

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the identifier for this event.

Returns:

the identifier for this event.

Since:

9.0.0

getFields

Collection<IMonitorEventField> getFields()

Returns the fields of this event.

Returns:

the fields of this event.

Since:

9.0.0

addField

IMonitorEvent addField(IMonitorField field,
                       boolean required)

Adds the given field in this event.

Parameters:

field - the field.

required - indicates whether the given field is required.

Returns:

this event for chaining.

Since:

9.0.0

getDescription

String getDescription()

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

Returns:

the description for this event.

Since:

9.0.0

setDescription

IMonitorEvent setDescription(String description)

Sets the description for this event.

Parameters:

description - the description to set.

Returns:

this event for chaining.

Since:

9.0.0

See Also:

getDescription()

isEnabled

boolean isEnabled()

Returns if the monitoring for this event is enabled.

Returns:

true if enabled or false if disabled.

Since:

9.0.0

setEnabled

IMonitorEvent setEnabled(boolean enabled)

Enables or disables the monitoring of this event.

Parameters:

enabled - true to enable or false to disable.

Returns:

this event for chaining.

Since:

9.0.0

getName

String getName()

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

Returns:

the name for this event.

Since:

9.0.0

setName

IMonitorEvent setName(String name)

Sets the name for this event.

Parameters:

name - the name

Returns:

this event for chaining.

Since:

9.0.0

See Also:

getName()

getStringResourcePath

String getStringResourcePath()

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

Returns:

the string resource path.

Since:

9.0.0

setStringResourcePath

IMonitorEvent setStringResourcePath(String stringResourcePath)

Sets the string resource path for this event.

Parameters:

stringResourcePath - the string resource path.

Returns:

this event for chaining.

Since:

9.0.0

See Also:

getStringResourcePath()