Package lumis.portal.monitor

Interface IMonitorEventSPI

All Superinterfaces:

IMonitorElementSPI<IMonitorEventSPI>, IMonitorEvent

All Known Implementing Classes:

MonitorEvent

public interface IMonitorEventSPI
extends IMonitorEvent, IMonitorElementSPI<IMonitorEventSPI>

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

Since:

11.0.0

Version:

$Revision$ $Date$

Field Summary

Fields inherited from interface lumis.portal.monitor.IMonitorEvent

DEFAULT_EVENT_PREFIX

Method Summary

Modifier and Type	Method	Description
IMonitorEventSPI	addField(IMonitorField field, boolean required)	Adds the given field in this event.
IMonitorEventSPI	addFieldGroup(IMonitorFieldGroup fieldGroup, boolean required)	Adds the given field group in this event.
java.util.Collection<IMonitorFieldInstance>	getDirectFields()	Returns the fields that are associated with this event directly (not through a field group).
java.util.Collection<IMonitorFieldGroupInstance>	getFieldsGroups()	Returns the field groups associated with this event.
boolean	isProcessActionEvent()	Returns if the event is a process action event.
IMonitorEventSPI	removeField(java.lang.String fieldId)	Removes the given field.
IMonitorEventSPI	removeFieldGroup(java.lang.String fieldGroupId)	Removes the given field group.
IMonitorEventSPI	setDescription(java.lang.String description)	Sets the description for this event.
IMonitorEventSPI	setEnabled(boolean enabled)	Enables or disables the monitoring of this event.
IMonitorEventSPI	setImage(java.lang.String image)	Sets the image.
IMonitorEventSPI	setName(java.lang.String name)	Sets the name for this event.
IMonitorEventSPI	setProcessActionEvent(boolean isProcessActionEvent)	Sets this event either as process action event or a normal one.
IMonitorEventSPI	setStandard(boolean isStandard)	Sets this event either as standard or custom (non-standard).
IMonitorEventSPI	setStringResourcePath(java.lang.String stringResourcePath)	Sets the string resource path for this event.
IMonitorEventSPI	setVerb(java.lang.String verb)	Sets the image.

Methods inherited from interface lumis.portal.monitor.IMonitorElementSPI

getId, getServiceInstanceId

Methods inherited from interface lumis.portal.monitor.IMonitorEvent

getDescription, getFields, getId, getImage, getLocalizedDescription, getLocalizedName, getLocalizedVerb, getName, getStringResourcePath, getVerb, isEnabled

Method Detail

addField

IMonitorEventSPI 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

addFieldGroup

IMonitorEventSPI addFieldGroup(IMonitorFieldGroup fieldGroup,
                               boolean required)

Adds the given field group in this event.

Parameters:

fieldGroup - the field group

required - indicates whether the fields of the given field group are required.

Returns:

this event for chaining.

Since:

11.0.0

removeField

IMonitorEventSPI removeField(java.lang.String fieldId)

Removes the given field.

Parameters:

fieldId - the field identifier.

Returns:

this event.

Since:

10.2.0

removeFieldGroup

IMonitorEventSPI removeFieldGroup(java.lang.String fieldGroupId)

Removes the given field group.

Parameters:

fieldGroupId - the field group identifier.

Returns:

this event.

Since:

11.0.0

setDescription

IMonitorEventSPI setDescription(java.lang.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:

IMonitorEvent.getDescription()

setEnabled

IMonitorEventSPI 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

setName

IMonitorEventSPI setName(java.lang.String name)

Sets the name for this event.

Parameters:

name - the name

Returns:

this event for chaining.

Since:

9.0.0

See Also:

IMonitorEvent.getName()

setStringResourcePath

IMonitorEventSPI setStringResourcePath(java.lang.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:

IMonitorEvent.getStringResourcePath()

setStandard

IMonitorEventSPI setStandard(boolean isStandard)

Sets this event either as standard or custom (non-standard).

Parameters:

isStandard - true to mark this event as standard, false to custom.

Returns:

this event for chaining.

Since:

11.0.0

setProcessActionEvent

IMonitorEventSPI setProcessActionEvent(boolean isProcessActionEvent)

Sets this event either as process action event or a normal one.

Parameters:

isProcessActionEvent - true to mark this event as a process action one.

Returns:

this event for chaining.

Since:

11.0.0

setImage

IMonitorEventSPI setImage(java.lang.String image)

Sets the image.

Parameters:

image - the image value to set.

Since:

11.0.0

setVerb

IMonitorEventSPI setVerb(java.lang.String verb)

Sets the image.

Parameters:

image - the image value to set.

Since:

11.0.0

isProcessActionEvent

boolean isProcessActionEvent()

Returns if the event is a process action event.

Returns:

if the event is a process action event

Since:

11.0.0

getDirectFields

java.util.Collection<IMonitorFieldInstance> getDirectFields()

Returns the fields that are associated with this event directly (not through a field group).

Returns:

the fields that are associated with this event directly (not through a field group).

Since:

11.0.0

getFieldsGroups

java.util.Collection<IMonitorFieldGroupInstance> getFieldsGroups()

Returns the field groups associated with this event.

Returns:

the field groups associated with this event.

Since:

11.0.0