lumis.portal.monitor
Interface IEvent

@StableMinor(version="6.2",
             sinceVersion="4.1")
public interface IEvent

An event that may be monitored. Its definition specifies how its data is collected and aggregated.

Since:

4.1.0

See Also:

lumis.portal.monitor

Method Summary

Collection<? extends IAggregationType>	getAggregationTypes() Returns the aggregation types for this event.
ICategory	getCategory() Returns the category this event belongs to.
String	getDescription() Returns the description for this event.
long	getDuration() Returns the aggregation duration used for this event's data.
String	getEventKey() Returns the key for 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.
void	setDescription(String description) Sets the description for this event.
void	setDuration(long duration) Sets the duration for the aggregation of this event's data.
void	setEnabled(boolean enabled) Enables or disables the monitoring of this event.
void	setEventKey(String key) Sets the key for this event.
void	setName(String name) Sets the name for this event.
void	setStringResourcePath(String stringResourcePath) Sets the string resource path for this event.

Method Detail

getId

String getId()

Returns the identifier for this event.

Returns:

the identifier for this event.

Since:

4.1.0

getCategory

ICategory getCategory()

Returns the category this event belongs to.

Returns:

the category this event belongs to.

Since:

4.1.0

getAggregationTypes

Collection<? extends IAggregationType> getAggregationTypes()

Returns the aggregation types for this event.

Returns:

the aggregation types for this event.

Since:

4.1.0

getDescription

String getDescription()

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

Returns:

the description for this event.

Since:

4.1.0

setDescription

void setDescription(String description)

Sets the description for this event.

Parameters:

description - the description to set.

Since:

4.1.0

See Also:

getDescription()

getDuration

long getDuration()

Returns the aggregation duration used for this event's data.

Returns:

the duration in milliseconds.

Since:

4.1.0

setDuration

void setDuration(long duration)

Sets the duration for the aggregation of this event's data.

Parameters:

duration - the duration in milliseconds.

Since:

4.1.0

See Also:

getDuration()

isEnabled

boolean isEnabled()

Returns if the monitoring for this event is enabled.

Returns:

true if enabled or false if disabled.

Since:

4.1.0

setEnabled

void setEnabled(boolean enabled)

Enables or disables the monitoring of this event.

Parameters:

enabled - true to enable or false to disable.

Since:

4.1.0

getEventKey

String getEventKey()

Returns the key for this event. This key is a friendly unique identifier for this event.

Returns:

this event's key.

Since:

4.1.0

setEventKey

void setEventKey(String key)

Sets the key for this event.

Parameters:

key - the key.

Since:

4.1.0

See Also:

getEventKey()

getName

String getName()

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

Returns:

the name for this event.

Since:

4.1.0

setName

void setName(String name)

Sets the name for this event.

Parameters:

name - the name

Since:

4.1.0

See Also:

getName()

getStringResourcePath

String getStringResourcePath()

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

Returns:

the string resource path.

Since:

4.1.0

setStringResourcePath

void setStringResourcePath(String stringResourcePath)

Sets the string resource path for this event.

Parameters:

stringResourcePath - the string resource path.

Since:

4.1.0

See Also:

getStringResourcePath()