org.eclipse.hyades.models.cbe
Interface CBECommonBaseEvent

All Superinterfaces:

AbstractDefaultEvent, CBEDefaultEvent, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

CBECommonBaseEventImpl, CBECommonBaseEventWeakRef

public interface CBECommonBaseEvent
extends CBEDefaultEvent

A representation of the model object 'Common Base Event'. This class provides the the basic level of common properties for all problem artifacts.

The following features are supported:

• Local Instance Id
• Global Instance Id
• Creation Time
• Time Zone
• Severity
• Priority
• Msg
• Repeat Count
• Elapsed Time
• Sequence Number
• Version
• Other Data
• Context Data Elements
• Reporter Component Id
• Source Component Id
• Msg Data Element
• Situation
• Adjusted Creation Time

See Also:

CBEPackage.getCBECommonBaseEvent()

Generated

[EMF] Model

Field Summary

static java.lang.String

copyright

Method Summary

double	getAdjustedCreationTime() Returns the value of the 'Adjusted Creation Time' attribute
org.eclipse.emf.common.util.EList	getContextDataElements() Returns the value of the 'Context Data Elements' containment reference list.
double	getCreationTime() Returns the value of the 'Creation Time' attribute
long	getElapsedTime() Returns the value of the 'Elapsed Time' attribute
java.lang.String	getGlobalInstanceId() Returns the value of the 'Global Instance Id' attribute
java.lang.String	getLocalInstanceId() Returns the value of the 'Local Instance Id' attribute
java.lang.String	getMsg() Returns the value of the 'Msg' attribute
CBEMsgDataElement	getMsgDataElement() Returns the value of the 'Msg Data Element' containment reference
org.eclipse.emf.common.util.EList	getOtherData() Returns the value of the 'Other Data' attribute list.
short	getPriority() Returns the value of the 'Priority' attribute
short	getRepeatCount() Returns the value of the 'Repeat Count' attribute
CBEComponentIdentification	getReporterComponentId() Returns the value of the 'Reporter Component Id' containment reference
long	getSequenceNumber() Returns the value of the 'Sequence Number' attribute
short	getSeverity() Returns the value of the 'Severity' attribute.
CBESituation	getSituation() Returns the value of the 'Situation' containment reference
CBEComponentIdentification	getSourceComponentId() Returns the value of the 'Source Component Id' containment reference
short	getTimeZone() Returns the value of the 'Time Zone' attribute
java.lang.String	getVersion() Returns the value of the 'Version' attribute.
void	setCreationTime(double value) Sets the value of the 'Creation Time' attribute
void	setElapsedTime(long value) Sets the value of the 'Elapsed Time' attribute
void	setGlobalInstanceId(java.lang.String value) Sets the value of the 'Global Instance Id' attribute
void	setLocalInstanceId(java.lang.String value) Sets the value of the 'Local Instance Id' attribute
void	setMsg(java.lang.String value) Sets the value of the 'Msg' attribute
void	setMsgDataElement(CBEMsgDataElement value) Sets the value of the 'Msg Data Element' containment reference
void	setPriority(short value) Sets the value of the 'Priority' attribute
void	setRepeatCount(short value) Sets the value of the 'Repeat Count' attribute
void	setReporterComponentId(CBEComponentIdentification value) Sets the value of the 'Reporter Component Id' containment reference
void	setSequenceNumber(long value) Sets the value of the 'Sequence Number' attribute
void	setSeverity(short value) Sets the value of the 'Severity' attribute
void	setSituation(CBESituation value) Sets the value of the 'Situation' containment reference
void	setSourceComponentId(CBEComponentIdentification value) Sets the value of the 'Source Component Id' containment reference
void	setTimeZone(short value) Sets the value of the 'Time Zone' attribute
void	setVersion(java.lang.String value) Sets the value of the 'Version' attribute

Methods inherited from interface org.eclipse.hyades.models.cbe.CBEDefaultEvent

getExtendedProperties, getExtensionName, getSymptoms, isAnalyzed, setAnalyzed, setExtensionName

Methods inherited from interface org.eclipse.hyades.models.hierarchy.AbstractDefaultEvent

getAgent, setAgent

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Field Detail

copyright

static final java.lang.String copyright

See Also:

Constant Field Values

Generated

Method Detail

getLocalInstanceId

java.lang.String getLocalInstanceId()

Returns the value of the 'Local Instance Id' attribute.

If the meaning of the 'Local Instance Id' attribute isn't clear, there really should be more of a description here...

Source supplied event identifier. There is no guarantee that this value is globally unique and stays constant for the life of the event.

Returns:

the value of the 'Local Instance Id' attribute.

See Also:

setLocalInstanceId(String), CBEPackage.getCBECommonBaseEvent_LocalInstanceId()

Generated

[EMF] Model

setLocalInstanceId

void setLocalInstanceId(java.lang.String value)

Sets the value of the 'Local Instance Id' attribute.

Parameters:

value - the new value of the 'Local Instance Id' attribute.

See Also:

getLocalInstanceId()

Generated

getGlobalInstanceId

java.lang.String getGlobalInstanceId()

Returns the value of the 'Global Instance Id' attribute.

If the meaning of the 'Global Instance Id' attribute isn't clear, there really should be more of a description here...

A globally unique identifier for this specific Event instance.

Returns:

the value of the 'Global Instance Id' attribute.

See Also:

setGlobalInstanceId(String), CBEPackage.getCBECommonBaseEvent_GlobalInstanceId()

Generated

[EMF] Model

setGlobalInstanceId

void setGlobalInstanceId(java.lang.String value)

Sets the value of the 'Global Instance Id' attribute.

Parameters:

value - the new value of the 'Global Instance Id' attribute.

See Also:

getGlobalInstanceId()

Generated

getCreationTime

double getCreationTime()

Returns the value of the 'Creation Time' attribute.

If the meaning of the 'Creation Time' attribute isn't clear, there really should be more of a description here...

The time the artifact was created as defined by CIM datetime data type. If not defined then the event receiver must timestamp it. Following is excerpt regarding format is from the standard: yyyymmddhhmmss.mmmmmmsutc (Must always be 25 characters - zero-padded if necessary) yyyy is a 4 digit year mm is the month dd is the day hh is the hour mm is the minutes ss is the second mmmmmm is the number of microseconds s is a "+" or "-" indicating the sign of UTC (Universal Coordinate Time - same as Greenwich Mean Time) or simply a ":" indicating a time interval (in case of using : yymm are interpreted as days) utc is the offset from UTC in minutes and ignored for the time interval For example 19980525145013.0000000-300 is Monday, May 25, 1998 at 2:50:13 PM EST.

Returns:

the value of the 'Creation Time' attribute.

See Also:

setCreationTime(double), CBEPackage.getCBECommonBaseEvent_CreationTime()

Generated

[EMF] Model

setCreationTime

void setCreationTime(double value)

Sets the value of the 'Creation Time' attribute.

Parameters:

value - the new value of the 'Creation Time' attribute.

See Also:

getCreationTime()

Generated

getTimeZone

short getTimeZone()

Returns the value of the 'Time Zone' attribute.

If the meaning of the 'Time Zone' attribute isn't clear, there really should be more of a description here...

The time zone part from the original XML fragment (eg. -240), see creationTime.

Returns:

the value of the 'Time Zone' attribute.

See Also:

setTimeZone(short), CBEPackage.getCBECommonBaseEvent_TimeZone()

Generated

[EMF] Model

setTimeZone

void setTimeZone(short value)

Sets the value of the 'Time Zone' attribute.

Parameters:

value - the new value of the 'Time Zone' attribute.

See Also:

getTimeZone()

Generated

getSeverity

short getSeverity()

Returns the value of the 'Severity' attribute. The default value is "10".

If the meaning of the 'Severity' attribute isn't clear, there really should be more of a description here...

Events can be classified with different severity levels. This enables administrators to focus on the most severe problems currently occurring in the enterprise. The event adapter can optionally assign the value for this attribute. If the event adapter does not assign a severity level, the default severity level in the event class definition is assigned by the event server. This attribute is extensible; you can add a new severity level by appending to the severities list defined in the event class definition files. The predefined severity levels, in order of increasing severity, are as follows: Information " Unknown " Harmless error that has no effect on the resource " Warning should be used when it's appropriate to let the user decide if action is needed. " Minor should be used to indicate action is needed, but the situation is not serious at this time. " Critical should be used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result). " Fatal should be used to indicate an error occurred, but it's too late to take remedial action. Enumeration values start at 0 and go to 60. Default is unknown (10) Default value is Unknown.

Returns:

the value of the 'Severity' attribute.

See Also:

setSeverity(short), CBEPackage.getCBECommonBaseEvent_Severity()

Generated

[EMF] Model

default="10"

setSeverity

void setSeverity(short value)

Sets the value of the 'Severity' attribute.

Parameters:

value - the new value of the 'Severity' attribute.

See Also:

getSeverity()

Generated

getPriority

short getPriority()

Returns the value of the 'Priority' attribute.

If the meaning of the 'Priority' attribute isn't clear, there really should be more of a description here...

Defines the importance of the event " Unknown " Ignore " Low " Medium " High " Critical Default value is Unknown.

Returns:

the value of the 'Priority' attribute.

See Also:

setPriority(short), CBEPackage.getCBECommonBaseEvent_Priority()

Generated

[EMF] Model

setPriority

void setPriority(short value)

Sets the value of the 'Priority' attribute.

Parameters:

value - the new value of the 'Priority' attribute.

See Also:

getPriority()

Generated

getMsg

java.lang.String getMsg()

Returns the value of the 'Msg' attribute.

If the meaning of the 'Msg' attribute isn't clear, there really should be more of a description here...

The content of this optional string is determined by the event creator. A typical usage would be the fully resolved and human readable message associated with this event.

Returns:

the value of the 'Msg' attribute.

See Also:

setMsg(String), CBEPackage.getCBECommonBaseEvent_Msg()

Generated

[EMF] Model

setMsg

void setMsg(java.lang.String value)

Sets the value of the 'Msg' attribute.

Parameters:

value - the new value of the 'Msg' attribute.

See Also:

getMsg()

Generated

getRepeatCount

short getRepeatCount()

Returns the value of the 'Repeat Count' attribute.

If the meaning of the 'Repeat Count' attribute isn't clear, there really should be more of a description here...

This optional property is the number of occurrences of a given message artifact for a specific time interval. The Time interval is indicated by the ElapsedTime property described below.

Returns:

the value of the 'Repeat Count' attribute.

See Also:

setRepeatCount(short), CBEPackage.getCBECommonBaseEvent_RepeatCount()

Generated

[EMF] Model

setRepeatCount

void setRepeatCount(short value)

Sets the value of the 'Repeat Count' attribute.

Parameters:

value - the new value of the 'Repeat Count' attribute.

See Also:

getRepeatCount()

Generated

getElapsedTime

long getElapsedTime()

Returns the value of the 'Elapsed Time' attribute.

If the meaning of the 'Elapsed Time' attribute isn't clear, there really should be more of a description here...

This optional property is the time interval or the elapsed time for the number occurrences of message artifact provided by the MessageCount property. This property is expressed in microseconds.

Returns:

the value of the 'Elapsed Time' attribute.

See Also:

setElapsedTime(long), CBEPackage.getCBECommonBaseEvent_ElapsedTime()

Generated

[EMF] Model

setElapsedTime

void setElapsedTime(long value)

Sets the value of the 'Elapsed Time' attribute.

Parameters:

value - the new value of the 'Elapsed Time' attribute.

See Also:

getElapsedTime()

Generated

getSequenceNumber

long getSequenceNumber()

Returns the value of the 'Sequence Number' attribute.

If the meaning of the 'Sequence Number' attribute isn't clear, there really should be more of a description here...

Optional sequnce numbers are used to provide order at a greater granularity than the time stamps.

Returns:

the value of the 'Sequence Number' attribute.

See Also:

setSequenceNumber(long), CBEPackage.getCBECommonBaseEvent_SequenceNumber()

Generated

[EMF] Model

setSequenceNumber

void setSequenceNumber(long value)

Sets the value of the 'Sequence Number' attribute.

Parameters:

value - the new value of the 'Sequence Number' attribute.

See Also:

getSequenceNumber()

Generated

getVersion

java.lang.String getVersion()

Returns the value of the 'Version' attribute. The default value is "1.0.1".

If the meaning of the 'Version' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Version' attribute.

See Also:

setVersion(String), CBEPackage.getCBECommonBaseEvent_Version()

Generated

[EMF] Model

default="1.0.1"

setVersion

void setVersion(java.lang.String value)

Sets the value of the 'Version' attribute.

Parameters:

value - the new value of the 'Version' attribute.

See Also:

getVersion()

Generated

getOtherData

org.eclipse.emf.common.util.EList getOtherData()

Returns the value of the 'Other Data' attribute list. The list contents are of type String.

If the meaning of the 'Other Data' attribute list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Other Data' attribute list.

See Also:

CBEPackage.getCBECommonBaseEvent_OtherData()

Generated

[EMF] Model

type="java.lang.String"

getContextDataElements

org.eclipse.emf.common.util.EList getContextDataElements()

Returns the value of the 'Context Data Elements' containment reference list. The list contents are of type CBEContextDataElement.

If the meaning of the 'Context Data Elements' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Context Data Elements' containment reference list.

See Also:

CBEPackage.getCBECommonBaseEvent_ContextDataElements()

Generated

[EMF] Model

type="org.eclipse.hyades.models.cbe.CBEContextDataElement" containment="true"

getReporterComponentId

CBEComponentIdentification getReporterComponentId()

Returns the value of the 'Reporter Component Id' containment reference.

If the meaning of the 'Reporter Component Id' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Reporter Component Id' containment reference.

See Also:

setReporterComponentId(CBEComponentIdentification), CBEPackage.getCBECommonBaseEvent_ReporterComponentId()

Generated

[EMF] Model

containment="true"

setReporterComponentId

void setReporterComponentId(CBEComponentIdentification value)

Sets the value of the 'Reporter Component Id' containment reference.

Parameters:

value - the new value of the 'Reporter Component Id' containment reference.

See Also:

getReporterComponentId()

Generated

getSourceComponentId

CBEComponentIdentification getSourceComponentId()

Returns the value of the 'Source Component Id' containment reference.

If the meaning of the 'Source Component Id' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Source Component Id' containment reference.

See Also:

setSourceComponentId(CBEComponentIdentification), CBEPackage.getCBECommonBaseEvent_SourceComponentId()

Generated

[EMF] Model

containment="true" required="true"

setSourceComponentId

void setSourceComponentId(CBEComponentIdentification value)

Sets the value of the 'Source Component Id' containment reference.

Parameters:

value - the new value of the 'Source Component Id' containment reference.

See Also:

getSourceComponentId()

Generated

getMsgDataElement

CBEMsgDataElement getMsgDataElement()

Returns the value of the 'Msg Data Element' containment reference.

If the meaning of the 'Msg Data Element' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Msg Data Element' containment reference.

See Also:

setMsgDataElement(CBEMsgDataElement), CBEPackage.getCBECommonBaseEvent_MsgDataElement()

Generated

[EMF] Model

containment="true"

setMsgDataElement

void setMsgDataElement(CBEMsgDataElement value)

Sets the value of the 'Msg Data Element' containment reference.

Parameters:

value - the new value of the 'Msg Data Element' containment reference.

See Also:

getMsgDataElement()

Generated

getSituation

CBESituation getSituation()

Returns the value of the 'Situation' containment reference.

If the meaning of the 'Situation' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Situation' containment reference.

See Also:

setSituation(CBESituation), CBEPackage.getCBECommonBaseEvent_Situation()

Generated

[EMF] Model

containment="true"

setSituation

void setSituation(CBESituation value)

Sets the value of the 'Situation' containment reference.

Parameters:

value - the new value of the 'Situation' containment reference.

See Also:

getSituation()

Generated

getAdjustedCreationTime

double getAdjustedCreationTime()

Returns the value of the 'Adjusted Creation Time' attribute.

If the meaning of the 'Adjusted Creation Time' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Adjusted Creation Time' attribute.

See Also:

CBEPackage.getCBECommonBaseEvent_AdjustedCreationTime()

Generated

[EMF] Model

transient="true" changeable="false" volatile="true" derived="true"