ilog.tgo.model

Class IltAlarm.AbstractSeverity

java.lang.Object

ilog.util.IlEnum

ilog.tgo.model.IltAlarm.AbstractSeverity

All Implemented Interfaces:

ilog.cpl.util.internal.IlpLabel, ilog.cpl.util.internal.IlpMutableLabel, IltAlarmSeverity, Comparable

Direct Known Subclasses:

IltAlarm.ImpactSeverity, IltAlarm.Severity

Enclosing class:

IltAlarm

protected abstract static class IltAlarm.AbstractSeverity
extends IlEnum
implements IltAlarmSeverity, ilog.cpl.util.internal.IlpMutableLabel

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_description An arbitrary string describing the severity.
protected String	_message Message from catalog
protected int	_severity A numerical value for the severity.

Fields inherited from class ilog.util.IlEnum

metainfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSeverity()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
void	copy(IltAlarm.AbstractSeverity from) Copies the attributes from the given severity to this instance.
String	getDescription(IlpContext appContext) Deprecated. Use getLabel(Locale) instead.
String	getLabel(Locale locale) Returns a localized description of the severity.
int	getSeverity() Returns the severity index.
int	hashCode() Support for hash tables
void	setDescription(String description) Deprecated. Use setLabel(String) instead.
void	setLabel(String label) Sets the label.
void	setMessage(String description) Sets the description of the severity as a message from the JTGO catalog.
void	setName(String name) Sets the severity name.
void	setSeverity(int value) Sets the severity attribute.

Methods inherited from class ilog.util.IlEnum

getName, intern, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.tgo.model.IltAlarmSeverity

equals, getCategory, getName, intern

Field Detail

_severity

protected int _severity

A numerical value for the severity.

Internal: do not use!

_description

protected String _description

An arbitrary string describing the severity.

Internal: do not use!

_message

protected String _message

Message from catalog

Internal: do not use!

Constructor Detail

AbstractSeverity

protected AbstractSeverity()

Method Detail

getLabel

public String getLabel(Locale locale)

Returns a localized description of the severity.

Specified by:

getLabel in interface ilog.cpl.util.internal.IlpLabel

Parameters:

locale - The locale used to retrieve the label.

Since:

JTGO 4.0

See Also:

Locale

Internal: do not use!

setLabel

public void setLabel(String label)

Sets the label.

Specified by:

setLabel in interface ilog.cpl.util.internal.IlpMutableLabel

Parameters:

label - The new label to be set.

Since:

JTGO 4.0

Internal: do not use!

getDescription

@Deprecated
public String getDescription(IlpContext appContext)

Deprecated. Use getLabel(Locale) instead.

Description copied from interface: IltAlarmSeverity

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

Specified by:

getDescription in interface IltAlarmSeverity

Since:

JTGO 3.1

Internal: do not use!

Deprecated Since:

JTGO 4.0

setDescription

@Deprecated
public void setDescription(String description)

Deprecated. Use setLabel(String) instead.

Sets the description of the severity.

Internal: do not use!

Deprecated Since:

JTGO 4.0

setMessage

public void setMessage(String description)

Sets the description of the severity as a message from the JTGO catalog.

Since:

JTGO 3.1

Internal: do not use!

getSeverity

public int getSeverity()

Returns the severity index.

Specified by:

getSeverity in interface IltAlarmSeverity

setSeverity

public void setSeverity(int value)

Sets the severity attribute.

setName

public void setName(String name)

Sets the severity name. This method is used by CSS styling mechanism and is not meant to be called directly.

Overrides:

setName in class IlEnum

Internal: do not use!

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Internal: do not use!

hashCode

public int hashCode()

Support for hash tables

Specified by:

hashCode in interface IltAlarmSeverity

Overrides:

hashCode in class Object

Internal: do not use!

copy

public void copy(IltAlarm.AbstractSeverity from)

Copies the attributes from the given severity to this instance.

Parameters:

from - Source severity

Internal: do not use!