ilog.tgo.model

Interface IltAlarmSeverity

All Superinterfaces:

Comparable, ilog.cpl.util.internal.IlpLabel

All Known Implementing Classes:

IltAlarm.AbstractSeverity, IltAlarm.ImpactSeverity, IltAlarm.Severity, IltTrap.Type

public interface IltAlarmSeverity
extends Comparable, ilog.cpl.util.internal.IlpLabel

This interface defines the methods used to represent a severity in the alarm system.

Since:

JTGO 3.1

See Also:

IltAlarmSystem, IltAlarm.Severity, IltTrap.Type

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Support for hash tables.
String	getCategory() Returns the category of this severity.
String	getDescription(IlpContext appContext) Deprecated. Use ilog.cpl.util.IlpLabel.getLabel(Locale) instead.
String	getName() Returns the identification of this severity.
int	getSeverity() Returns the severity index used to indicate the order of severities in the system.
int	hashCode() Support for hash tables.
IlEnum	intern() Returns a canonical representation for this object.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface ilog.cpl.util.internal.IlpLabel

getLabel

Method Detail

getName

String getName()

Returns the identification of this severity.

getSeverity

int getSeverity()

Returns the severity index used to indicate the order of severities in the system. The order is mainly used to find the highest alarm severity set in an object.

getCategory

String getCategory()

Returns the category of this severity.

Returns:

Alarm severity category, for instance Raw or Impact

Since:

JTGO 4.5

getDescription

@Deprecated
String getDescription(IlpContext appContext)

Deprecated. Use ilog.cpl.util.IlpLabel.getLabel(Locale) instead.

Returns the description of this alarm severity for the given context.

Deprecated Since:

JTGO 4.0

hashCode

int hashCode()

Support for hash tables.

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Support for hash tables.

Overrides:

equals in class Object

intern

IlEnum intern()

Returns a canonical representation for this object.