org.eclipse.tptp.logging.events.cbe
Interface ReportSituation

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable, SituationType

All Known Implementing Classes:

ReportSituationImpl

public interface ReportSituation
extends SituationType

Interface representing a ReportSituation.

The following description is from the Common Base Event v1.0.1 specification entitled "Canonical Situation Data Format: The Common Base Event V1.0.1":

The ReportSituation deals with the situations reported from the component, such as heartbeat or performance information. Data such as current CPU utilization, current memory heap size, etc. would fall into this category. Existing messages include words like "utilization value is", "buffer size is", and "number of threads is", for example:

• IEE890I WTO Buffers in console backup storage = 1024

Method Summary

java.lang.String	getReportCategory() Returns the value of the 'Report Category' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setReportCategory(java.lang.String value) Sets the value of the ' Report Category' attribute.

Methods inherited from interface org.eclipse.tptp.logging.events.cbe.SituationType

getReasoningScope, setReasoningScope, validate

Method Detail

getReportCategory

java.lang.String getReportCategory()

Returns the value of the 'Report Category' attribute.

Returns:

the value of the 'Report Category' attribute.

See Also:

setReportCategory(String)

setReportCategory

void setReportCategory(java.lang.String value)

Sets the value of the ' Report Category' attribute.

This property specifies the category of the reported situation. The reportCategory is a string with the following set of values:

• PERFORMANCE
• SECURITY
• HEARTBEAT
• STATUS

This is a required property and once it is set it must not change. The string length for this property must not exceed 64 characters.

Parameters:

value - the new value of the 'Report Category' attribute.

See Also:

getReportCategory()

init

void init()

Resets the object's properties to their initial (e.g. null) state. All components are initialized to either zero or null.

Specified by:

init in interface SituationType