lumis.portal.monitor
Interface ICategory

@StableMinor(version="6.1",
             sinceVersion="4.1")
public interface ICategory

A category of monitored IEvent's. A category has the objective to organize events into groups.

Since:

4.1.0

Method Summary

void	addEvent(IEvent event) Adds an event to this category.
java.lang.String	getDescription() Returns the description for this category.
java.util.Collection<? extends IEvent>	getEvents() Returns the collection of events that belong to this category.
java.lang.String	getId() Returns the identifier for this category.
java.lang.String	getName() Returns the name for this category.
java.lang.String	getStringResourcePath() The string resource path for localizing this category's strings.
void	setDescription(java.lang.String description) Sets the description for this category.
void	setName(java.lang.String name) Sets the name for this category.
void	setStringResourcePath(java.lang.String stringResourcePath) Sets the string resource path for this category.

Method Detail

getId

java.lang.String getId()

Returns the identifier for this category.

Returns:

the identifier for this category.

Since:

4.1.0

getEvents

java.util.Collection<? extends IEvent> getEvents()

Returns the collection of events that belong to this category.

Returns:

this category's events.

Since:

4.1.0

addEvent

void addEvent(IEvent event)

Adds an event to this category. If the event belongs to another category it will be removed from it when persisted.

Parameters:

event - the event to add.

Since:

4.1.0

getDescription

java.lang.String getDescription()

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

Returns:

the description for this category.

Since:

4.1.0

setDescription

void setDescription(java.lang.String description)

Sets the description for this category.

Parameters:

description - the description to set.

Since:

4.1.0

See Also:

getDescription()

getName

java.lang.String getName()

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

Returns:

the name for this category.

Since:

4.1.0

setName

void setName(java.lang.String name)

Sets the name for this category.

Parameters:

name - the name.

Since:

4.1.0

See Also:

getName()

getStringResourcePath

java.lang.String getStringResourcePath()

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

Returns:

the string resource path.

Since:

4.1.0

setStringResourcePath

void setStringResourcePath(java.lang.String stringResourcePath)

Sets the string resource path for this category.

Parameters:

stringResourcePath - the string resource path.

Since:

4.1.0

See Also:

getStringResourcePath()