ilog.tgo.model

Class IltTrap.Type

java.lang.Object

ilog.util.IlEnum

ilog.tgo.model.IltTrap.Type

All Implemented Interfaces:

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

Enclosing class:

IltTrap

public static class IltTrap.Type
extends IlEnum
implements IltAlarmSeverity, ilog.cpl.util.internal.IlpMutableLabel

This enumeration lists the possible types of traps supported by the system.

Field Summary

Fields

Modifier and Type	Field and Description
static IltTrap.Type	AuthenticationFailure
static IltTrap.Type	ColdStart
static IltTrap.Type	EGPNeighborLoss
static IltTrap.Type	LinkFailure
static IlEnumInfo	metainfo Contains metainformation about this IlEnum class.
static IltTrap.Type	WarmStart

Constructor Summary

Constructors

Constructor and Description
Type() Creates a new trap type.
Type(String name, int severity) Creates a new trap type.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
void	copy(IltTrap.Type from) Copies the attributes from the given type.
String	getCategory() Returns the category of this type.
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, getName, intern

Field Detail

ColdStart

public static IltTrap.Type ColdStart

WarmStart

public static IltTrap.Type WarmStart

LinkFailure

public static IltTrap.Type LinkFailure

AuthenticationFailure

public static IltTrap.Type AuthenticationFailure

EGPNeighborLoss

public static IltTrap.Type EGPNeighborLoss

metainfo

public static IlEnumInfo metainfo

Contains metainformation about this IlEnum class.

Internal: do not use!

Constructor Detail

Type

public Type()

Creates a new trap type. Magic constructor.

Internal: do not use!

Type

public Type(String name,
            int severity)

Creates a new trap type.

Parameters:

name - a name for the severity, used for serialization purposes

Method Detail

getCategory

public String getCategory()

Returns the category of this type.

Specified by:

getCategory in interface IltAlarmSeverity

Returns:

Trap.Type

Since:

JTGO 4.5

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.

Internal: do not use!

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!

hashCode

public int hashCode()

Support for hash tables.

Specified by:

hashCode in interface IltAlarmSeverity

Overrides:

hashCode in class Object

Internal: do not use!

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Internal: do not use!

copy

public void copy(IltTrap.Type from)

Copies the attributes from the given type.

Parameters:

from - Source trap type

Since:

JViews 7.5

Internal: do not use!