IltAlarm (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.cpl.model.IlpDefaultObject
- - ilog.tgo.model.IltAlarm

All Implemented Interfaces:

IlpAttributeValueHolder, IlpObject
```
public class IltAlarm
extends IlpDefaultObject
```
A predefined business object for an alarm condition in a managed telecom object. Its definition is based on the OSS/J Quality of the Service API.

This class also provides the state system used to model the alarm state carried by a telecom object. Its definition is based on the ITU-T Recommendation X.733.

The class IltAlarm.State models the alarm state carried by a telecom object.

See Also:

IltObjectState.getAlarmState()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`IltAlarm.AbstractSeverity`
`static class`	`IltAlarm.AlarmType` This enumeration lists the possible types of alarms.
`static class`	`IltAlarm.ImpactSeverity` This enumeration lists the possible severity levels for impact alarms.
`static class`	`IltAlarm.ProbableCause` This enumeration lists the possible probable causes for alarms.
`static class`	`IltAlarm.Severity` This enumeration lists the possible severity levels for raw alarms.
`static class`	`IltAlarm.State` This class provides a representation model for the alarm state carried by a telecom object.
`static class`	`IltAlarm.TrendIndication` This enumeration lists the possible trend indications.

Field Summary

Fields
Modifier and Type	Field and Description
`static IlpAttribute`	`AckSystemIdAttribute` Identifier of the system used by the author of the last modification of the acknowledged state.
`static IlpAttribute`	`AckTimeAttribute` Date of the last modification of the acknowledged state.
`static IlpAttribute`	`AckUserIdAttribute` Identifier of the author of the last modication of the acknowledged state.
`static IlpAttribute`	`AdditionalTextAttribute` The additional text.
`static IlpAttribute`	`AlarmAckStateAttribute` The alarm acknowledged state.
`static IlpAttribute`	`AlarmChangedTimeAttribute` Date of the last modification of alarm attribute values.
`static IlpAttribute`	`AlarmClearedTimeAttribute` Date when the perceived severity of the alarm was changed to cleared.
`static IlpAttribute`	`AlarmRaisedTimeAttribute` Date when the alarm was raised.
`static IlpAttribute`	`AlarmTypeAttribute` The type of alarm.
`static IlpAttribute`	`AttributeChangesAttribute` The list of changed attributes.
`static IlpAttribute`	`BackedUpStatusAttribute` Backup status.
`static IlpAttribute`	`BackUpObjectAttribute` Distinguished name of the backup object.
`static IlpAttribute`	`ClearSystemIdAttribute` Identifier of the system used by the author of the last request to clear the alarm.
`static IlpAttribute`	`ClearUserIdAttribute` Identifier of the author of the last request to clear the alarm.
`static IlpAttribute`	`CommentsAttribute` List of comments.
`static IlpAttribute`	`CorrelatedNotificationsAttribute` The correlated notifications.
`static IlpComputedAttribute`	`GraphicRepresentationAttribute` A fake attribute allowing the display of a graphic representation of the alarm in a table column.
`static IlpAttribute`	`ManagedObjectClassAttribute` Managed object class of the managed object instance in which the alarm occurred.
`static IlpAttribute`	`ManagedObjectInstanceAttribute` The managed object instance in which the alarm occurred.
`static IlpAttribute`	`MonitoredAttributesAttribute` The monitored attributes.
`static IlpAttribute`	`NotificationIdAttribute` Identifier of the notification that carries the alarm information.
`static IlpAttribute`	`PerceivedSeverityAttribute` The perceived severity of the alarm.
`static IlpAttribute`	`ProbableCauseAttribute` The probable cause of the alarm.
`static IlpAttribute`	`ProposedRepairActionsAttribute` The proposed repair actions.
`static IlpAttribute`	`SpecificProblemAttribute` The specific problem.
`static IlpAttribute`	`SystemDNAttribute` The distinguished name (DN) of the system that detects the network event and generates the notification.
`protected static IlpDefaultClass`	`TheIlpClass` The `IlpClass` for this Java class.
`static IlpAttribute`	`ThresholdInfoAttribute` The threshold information.
`static IlpAttribute`	`TrendIndicationAttribute` The trend indication.

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder
VALUE_NOT_SET

Constructor Summary

Constructors
Constructor and Description
`IltAlarm()` Creates a new `IltAlarm`.
`IltAlarm(IlpClass ilpClass, boolean initializeAttributeValues)` Creates a new `IltAlarm`.
`IltAlarm(IlpClass ilpClass, Object identifier)` Creates a new `IltAlarm` with a given identifier and a given `IlpClass`.
`IltAlarm(Object objectIdentifier)` Creates a new `IltAlarm` with a given identifier.
`IltAlarm(Object identifier, IltAlarmSeverity perceivedSeverity, boolean acknowledgedState, Date raisedTime)` Creates a new `IltAlarm`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`ForceInit(ilog.tgo.util.internal.IltForceClassInit object)` For IltSystem.Init
`String`	`getAckSystemId()` Returns the identifier of the system used by the author of the last modification of the acknowledged state.
`Date`	`getAckTime()` Returns the date of the last modification of the acknowledged state.
`String`	`getAckUserId()` Returns the identifier of the author of the last modification of the acknowledged state.
`String`	`getAdditionalText()` Returns the additional text.
`boolean`	`getAlarmAckState()` Returns the alarm acknowledged state.
`Date`	`getAlarmChangedTime()` Returns the date of the last modification of alarm attribute values.
`Date`	`getAlarmClearedTime()` Returns the date when the perceived severity has been changed to cleared.
`Date`	`getAlarmRaisedTime()` Returns the date when the alarm has been raised.
`static IltAlarmSystem`	`GetAlarmSystem()` Returns the `IltAlarmSystem` for `IltAlarm`.
`IltAlarm.AlarmType`	`getAlarmType()` Returns the alarm type.
`Object`	`getAttributeChanges()` Returns the attribute changes
`boolean`	`getBackedUpStatus()` Returns the backup status of the managed object.
`String`	`getBackUpObject()` Returns the distinguished name of the backup object.
`String`	`getClearSystemId()` Returns the identifier of the system used by the author of the last request to clear the alarm.
`String`	`getClearUserId()` Returns the identifier of the author of the last request to clear the alarm.
`Object`	`getComments()` Returns the comments.
`Object`	`getCorrelatedNotifications()` Returns the correlated notifications.
`static IlpClass`	`GetIlpClass()` Returns the `IlpClass` corresponding to this Java class.
`static ilog.tgo.model.internal.IltStatePath`	`GetLossOfConnectivityStatePath()` Returns the path to access the loss of connectivity state inside the alarm system.
`String`	`getManagedObjectClass()` Returns the managed object class of the managed object instance in which the alarm occurred.
`Object`	`getManagedObjectInstance()` Returns the managed object instance in which the alarm occurred.
`Object`	`getMonitoredAttributes()` Returns the monitored attributes.
`String`	`getNotificationId()` Returns the identifier of the notification that carries the alarm information.
`static ilog.tgo.model.internal.IltStatePath`	`GetNotReportingStatePath()` Returns the path to access the `NotReporting` state in the alarm system.
`IltAlarmSeverity`	`getPerceivedSeverity()` Returns the perceived severity.
`IltAlarm.ProbableCause`	`getProbableCause()` Returns the probable cause.
`String`	`getProposedRepairActions()` Returns the proposed repair actions.
`String`	`getSpecificProblem()` Returns the specific problem.
`String`	`getSystemDN()` Returns the distinguished name (DN) of the system that has detected the network event and generated the notification.
`Object`	`getThresholdInfo()` Returns the threshold information.
`IltAlarm.TrendIndication`	`getTrendIndication()` Returns the trend indication.
`static void`	`InitStyle()` Initializes the style.
`void`	`setAckSystemId(String ackSystemId)` Sets the identifier of the system used by the author of the last modification of the acknowledged state.
`void`	`setAckTime(Date ackTime)` Sets the date of the last modification of the acknowledged state.
`void`	`setAckUserId(String ackUserId)` Sets the identifier of the author of the last modification of the acknowledged state.
`void`	`setAdditionalText(String additionalText)` Sets the additional text.
`void`	`setAlarmAckState(boolean alarmAckState)` Sets the alarm acknowledged state.
`void`	`setAlarmChangedTime(Date alarmChangedTime)` Sets the date of the last modification of alarm attribute values.
`void`	`setAlarmClearedTime(Date alarmClearedTime)` Sets the date when the perceived severity has been changed to cleared.
`void`	`setAlarmRaisedTime(Date alarmRaisedTime)` Sets the date when the alarm has been raised.
`void`	`setAlarmType(IltAlarm.AlarmType alarmType)` Sets the alarm type.
`void`	`setAttributeChanges(Object attributeChanges)` Sets the attribute changes.
`void`	`setBackedUpStatus(boolean backedUpStatus)` Sets the backup status.
`void`	`setBackUpObject(String backUpObject)` Sets the backup object.
`void`	`setClearSystemId(String clearSystemId)` Sets the identifier of the system used by the author of the last request to clear the alarm.
`void`	`setClearUserId(String clearUserId)` Sets the identifier of the author of the last request to clear the alarm.
`void`	`setComments(Object comments)` Sets the comments.
`void`	`setCorrelatedNotifications(Object notifications)` Sets the correlated notifications.
`void`	`setManagedObjectClass(String managedObjectClass)` Sets the managed object class of the managed object instance in which the alarm occurred.
`void`	`setManagedObjectInstance(Object managedObjectInstance)` Sets the managed object instance in which the alarm occurred.
`void`	`setMonitoredAttributes(Object attributes)` Sets the monitored attributes.
`void`	`setNotificationId(String notificationId)` Sets the identifier of the notification that carries the alarm information.
`void`	`setPerceivedSeverity(IltAlarmSeverity perceivedSeverity)` Sets the perceived severity.
`void`	`setProbableCause(IltAlarm.ProbableCause probableCause)` Sets the probable cause.
`void`	`setProposedRepairActions(String proposedRepairActions)` Sets the proposed repair actions.
`static void`	`SetSeverityMapping(IltAlarm.Severity severity, Color normal, Color bright, Color dark, char letter)` Deprecated. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`static void`	`SetSeverityMapping(IltAlarm.Severity severity, Color normal, Color bright, Color dark, char letter, String description)` Deprecated. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`static void`	`SetSeverityMapping(IltAlarm.Severity severity, IlpColorKey normalKey, Color defaultNormalValue, IlpColorKey brightKey, Color defaultBrightValue, IlpColorKey darkKey, Color defaultDarkValue, IlpStringKey abbreviationKey, String defaultAbbreviationValue, IlpStringKey expandedKey, String defaultExpandedValue)` Deprecated. Use `IltSettings.SetValue` instead.
`static void`	`SetSeverityMapping(IltAlarm.Severity severity, IltKey.Color normalKey, Color defaultNormalValue, IltKey.Color brightKey, Color defaultBrightValue, IltKey.Color darkKey, Color defaultDarkValue, IltKey.String abbreviationKey, String defaultAbbreviationValue)` Deprecated. The style API has been replaced by the cascading style sheet mechanism. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`static void`	`SetSeverityMapping(IltAlarm.Severity severity, IltKey.Color normalKey, Color defaultNormalValue, IltKey.Color brightKey, Color defaultBrightValue, IltKey.Color darkKey, Color defaultDarkValue, IltKey.String abbreviationKey, String defaultAbbreviationValue, IltKey.String expandedKey, String defaultExpandedValue)` Deprecated. The style API has been replaced by the cascading style sheet mechanism. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`static void`	`SetSeverityMapping(IltAlarmSeverity severity, Color normal, Color bright, Color dark, String shortText)` Deprecated. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`static void`	`SetSeverityMapping(IltAlarmSeverity severity, Color normal, Color bright, Color dark, String shortText, String description)` Deprecated. Use `IltSettings.SetValue(java.lang.Object, java.lang.Object)` instead.
`void`	`setSpecificProblem(String specificProblem)` Sets the specific problem.
`void`	`setSystemDN(String systemDN)` Sets the distinguished name (DN) of the system that has detected the network event and generated the notification.
`void`	`setThresholdInfo(Object thresholdInfo)` Sets the threshold information.
`void`	`setTrendIndication(IltAlarm.TrendIndication trendIndication)` Sets the trend indication.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TheIlpClass
```
protected static IlpDefaultClass TheIlpClass
```
    The IlpClass for this Java class.
    
    Internal: do not use!
  - GraphicRepresentationAttribute
```
public static IlpComputedAttribute GraphicRepresentationAttribute
```
    A fake attribute allowing the display of a graphic representation of the alarm in a table column.
    Attribute name: graphicRepresentation.
    By default, it is shown in the table.
    This attribute is computed from other attributes and should not be set a value directly.
    
    Since:
    
    JTGO 4.0
  - AckSystemIdAttribute
```
public static IlpAttribute AckSystemIdAttribute
```
    Identifier of the system used by the author of the last modification of the acknowledged state.
    Attribute name: ackSystemId.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AckTimeAttribute
```
public static IlpAttribute AckTimeAttribute
```
    Date of the last modification of the acknowledged state.
    Attribute name: ackTime.
    Value type: Date.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AckUserIdAttribute
```
public static IlpAttribute AckUserIdAttribute
```
    Identifier of the author of the last modication of the acknowledged state.
    Attribute name: ackUserId.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AdditionalTextAttribute
```
public static IlpAttribute AdditionalTextAttribute
```
    The additional text. It provides further information on the alarm.
    Attribute name: additionalText.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AlarmAckStateAttribute
```
public static IlpAttribute AlarmAckStateAttribute
```
    The alarm acknowledged state.
    Attribute name: alarmAckState.
    Value type: Boolean.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - AlarmChangedTimeAttribute
```
public static IlpAttribute AlarmChangedTimeAttribute
```
    Date of the last modification of alarm attribute values.
    Attribute name: alarmChangedTime.
    Value type: Date.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AlarmClearedTimeAttribute
```
public static IlpAttribute AlarmClearedTimeAttribute
```
    Date when the perceived severity of the alarm was changed to cleared.
    Attribute name: alarmClearedTime.
    Value type: Date.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AlarmRaisedTimeAttribute
```
public static IlpAttribute AlarmRaisedTimeAttribute
```
    Date when the alarm was raised.
    Attribute name: alarmRaisedTime.
    Value type: Date.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - AlarmTypeAttribute
```
public static IlpAttribute AlarmTypeAttribute
```
    The type of alarm.
    Attribute name: alarmType.
    Value type: IltAlarm.AlarmType.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - AttributeChangesAttribute
```
public static IlpAttribute AttributeChangesAttribute
```
    The list of changed attributes.
    Attribute name: attributeChanges.
    Value type: Object.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - BackedUpStatusAttribute
```
public static IlpAttribute BackedUpStatusAttribute
```
    Backup status. Indicates whether the managed object has a backup object.
    Attribute name: backedUpStatus.
    Value type: Boolean.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    BackUpObjectAttribute
  - BackUpObjectAttribute
```
public static IlpAttribute BackUpObjectAttribute
```
    Distinguished name of the backup object.
    Attribute name: backUpObject.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - ClearSystemIdAttribute
```
public static IlpAttribute ClearSystemIdAttribute
```
    Identifier of the system used by the author of the last request to clear the alarm.
    Attribute name: clearSystemId.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - CommentsAttribute
```
public static IlpAttribute CommentsAttribute
```
    List of comments.
    Attribute name: comments.
    Value type: Object.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - CorrelatedNotificationsAttribute
```
public static IlpAttribute CorrelatedNotificationsAttribute
```
    The correlated notifications. Identifies a set of notifications to which this notification is considered to be correlated.
    Attribute name: correlatedNotifications.
    Value type: Object.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - ClearUserIdAttribute
```
public static IlpAttribute ClearUserIdAttribute
```
    Identifier of the author of the last request to clear the alarm.
    Attribute name: clearUserId.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - ManagedObjectClassAttribute
```
public static IlpAttribute ManagedObjectClassAttribute
```
    Managed object class of the managed object instance in which the alarm occurred.
    Attribute name: managedObjectClass.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - ManagedObjectInstanceAttribute
```
public static IlpAttribute ManagedObjectInstanceAttribute
```
    The managed object instance in which the alarm occurred.
    Place here the object identifier of the managed object to allow the automatic update of the business object alarm state from the alarms.
    Attribute name: managedObjectInstance.
    Value type: Object.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - MonitoredAttributesAttribute
```
public static IlpAttribute MonitoredAttributesAttribute
```
    The monitored attributes.
    Attribute name: monitoredAttributes.
    Value type: Object.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - NotificationIdAttribute
```
public static IlpAttribute NotificationIdAttribute
```
    Identifier of the notification that carries the alarm information.
    Attribute name: notificationId.
    Value type: String.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - PerceivedSeverityAttribute
```
public static IlpAttribute PerceivedSeverityAttribute
```
    The perceived severity of the alarm.
    It indicates the relative level of urgency for the end user. Values are defined in IltAlarm.Severity for raw alarms, and in IltAlarm.ImpactSeverity for impact alarms.
    Attribute name: perceivedSeverity.
    Value type: IltAlarmSeverity.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - ProbableCauseAttribute
```
public static IlpAttribute ProbableCauseAttribute
```
    The probable cause of the alarm.
    Attribute name: probableCause.
    Value type: IltAlarm.ProbableCause.
    By default, it is shown in the table.
    
    Since:
    
    JTGO 4.0
  - ProposedRepairActionsAttribute
```
public static IlpAttribute ProposedRepairActionsAttribute
```
    The proposed repair actions.
    Attribute name: proposedRepairActions.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - SpecificProblemAttribute
```
public static IlpAttribute SpecificProblemAttribute
```
    The specific problem. Provides further qualification on the alarm than probableCause.
    Attribute name: specificProblem.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - SystemDNAttribute
```
public static IlpAttribute SystemDNAttribute
```
    The distinguished name (DN) of the system that detects the network event and generates the notification.
    Attribute name: systemDN.
    Value type: String.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - ThresholdInfoAttribute
```
public static IlpAttribute ThresholdInfoAttribute
```
    The threshold information.
    Attribute name: thresholdInfo.
    Value type: Object.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
  - TrendIndicationAttribute
```
public static IlpAttribute TrendIndicationAttribute
```
    The trend indication. It indicates whether an observed condition is getting better, worse, or not changing.
    Attribute name: trendIndication.
    Value type: IltAlarm.TrendIndication.
    By default, it is not shown in the table.
    
    Since:
    
    JTGO 4.0
- Constructor Detail
  - IltAlarm
```
public IltAlarm(Object objectIdentifier)
```
    Creates a new IltAlarm with a given identifier. The IlpClass is an IltAlarm.
    
    Parameters:
    
    objectIdentifier - The identifier of this instance. See IlpIDGenerator for a simple identifier generator and IlpObject.getIdentifier() for the constraints on identifiers.
    
    Since:
    
    JTGO 4.0
  - IltAlarm
```
public IltAlarm(IlpClass ilpClass,
                Object identifier)
```
    Creates a new IltAlarm with a given identifier and a given IlpClass.
    
    Parameters:
    
    ilpClass - The business class of this new instance. It must be a subclass of IltAlarm.
    
    identifier - The identifier of this instance. See IlpIDGenerator for a simple identifier generator and IlpObject.getIdentifier() for the constraints on identifiers.
    
    Since:
    
    JTGO 4.0
  - IltAlarm
```
public IltAlarm(IlpClass ilpClass,
                boolean initializeAttributeValues)
```
    Creates a new IltAlarm. An identifier is generated by the IlpIDGenerator.
    
    Parameters:
    
    ilpClass - The business class of this new instance. It must be a subclass of IltAlarm.
    
    initializeAttributeValues - Indicates whether the object should be initialized using the default attribute values.
    
    Since:
    
    JTGO 4.0
  - IltAlarm
```
public IltAlarm()
```
    Creates a new IltAlarm. An identifier is generated by the IlpIDGenerator. Attributes are initialized to their default values.
    
    Since:
    
    JTGO 4.0
  - IltAlarm
```
public IltAlarm(Object identifier,
                IltAlarmSeverity perceivedSeverity,
                boolean acknowledgedState,
                Date raisedTime)
```
    Creates a new IltAlarm. An identifier is generated by the IlpIDGenerator.
    
    Parameters:
    
    identifier - The identifier of this instance. See IlpIDGenerator for a simple identifier generator and IlpObject.getIdentifier() for the constraints on identifiers.
    
    perceivedSeverity - The perceived severity.
    
    acknowledgedState - The acknowledgedment state.
    
    raisedTime - The alarm raised time.
    
    Since:
    
    JTGO 4.0
- Method Detail
  - GetAlarmSystem
```
public static IltAlarmSystem GetAlarmSystem()
```
    Returns the IltAlarmSystem for IltAlarm.
    
    Internal: do not use!
  - GetLossOfConnectivityStatePath
```
public static ilog.tgo.model.internal.IltStatePath GetLossOfConnectivityStatePath()
```
    Returns the path to access the loss of connectivity state inside the alarm system.
    
    Internal: do not use!
  - GetNotReportingStatePath
```
public static ilog.tgo.model.internal.IltStatePath GetNotReportingStatePath()
```
    Returns the path to access the NotReporting state in the alarm system.
    
    Internal: do not use!
  - GetIlpClass
```
public static IlpClass GetIlpClass()
```
    Returns the IlpClass corresponding to this Java class.
    
    Since:
    
    JTGO 4.0
  - getAckSystemId
```
public String getAckSystemId()
```
    Returns the identifier of the system used by the author of the last modification of the acknowledged state.
    
    See Also:
    
    getAlarmAckState()
  - setAckSystemId
```
public void setAckSystemId(String ackSystemId)
```
    Sets the identifier of the system used by the author of the last modification of the acknowledged state.
    
    Parameters:
    
    ackSystemId - The identifier to be set.
    
    See Also:
    
    getAlarmAckState()
  - getAckTime
```
public Date getAckTime()
```
    Returns the date of the last modification of the acknowledged state.
    
    See Also:
    
    setAlarmAckState(boolean)
  - setAckTime
```
public void setAckTime(Date ackTime)
```
    Sets the date of the last modification of the acknowledged state.
    
    Parameters:
    
    ackTime - The date to be set.
  - getAckUserId
```
public String getAckUserId()
```
    Returns the identifier of the author of the last modification of the acknowledged state.
    
    See Also:
    
    setAlarmAckState(boolean)
  - setAckUserId
```
public void setAckUserId(String ackUserId)
```
    Sets the identifier of the author of the last modification of the acknowledged state.
    
    Parameters:
    
    ackUserId - The identifier to be set.
    
    See Also:
    
    setAlarmAckState(boolean)
  - getAdditionalText
```
public String getAdditionalText()
```
    Returns the additional text. It provides further information on the alarm.
  - setAdditionalText
```
public void setAdditionalText(String additionalText)
```
    Sets the additional text. It provides further information on the alarm.
    
    Parameters:
    
    additionalText - The additional text to be set.
  - getAlarmAckState
```
public boolean getAlarmAckState()
```
    Returns the alarm acknowledged state.
    
    Returns:
    
    true when the alarm is acknowledged, or false when it is not acknowledged.
  - setAlarmAckState
```
public void setAlarmAckState(boolean alarmAckState)
```
    Sets the alarm acknowledged state.
    
    Parameters:
    
    alarmAckState - The acknowledged state to be set.
  - getAlarmChangedTime
```
public Date getAlarmChangedTime()
```
    Returns the date of the last modification of alarm attribute values.
  - setAlarmChangedTime
```
public void setAlarmChangedTime(Date alarmChangedTime)
```
    Sets the date of the last modification of alarm attribute values.
    
    Parameters:
    
    alarmChangedTime - The date to be set.
  - getAlarmClearedTime
```
public Date getAlarmClearedTime()
```
    Returns the date when the perceived severity has been changed to cleared.
  - setAlarmClearedTime
```
public void setAlarmClearedTime(Date alarmClearedTime)
```
    Sets the date when the perceived severity has been changed to cleared.
    
    Parameters:
    
    alarmClearedTime - The date to be set.
  - getAlarmRaisedTime
```
public Date getAlarmRaisedTime()
```
    Returns the date when the alarm has been raised.
  - setAlarmRaisedTime
```
public void setAlarmRaisedTime(Date alarmRaisedTime)
```
    Sets the date when the alarm has been raised.
    
    Parameters:
    
    alarmRaisedTime - The date to be set.
  - getAlarmType
```
public IltAlarm.AlarmType getAlarmType()
```
    Returns the alarm type.
  - setAlarmType
```
public void setAlarmType(IltAlarm.AlarmType alarmType)
```
    Sets the alarm type.
    
    Parameters:
    
    alarmType - The alarm type to be set.
  - getAttributeChanges
```
public Object getAttributeChanges()
```
    Returns the attribute changes
  - setAttributeChanges
```
public void setAttributeChanges(Object attributeChanges)
```
    Sets the attribute changes.
    
    Parameters:
    
    attributeChanges - The attribute changes to be set.
  - getBackedUpStatus
```
public boolean getBackedUpStatus()
```
    Returns the backup status of the managed object. Indicates whether the managed object has a backup object.
  - setBackedUpStatus
```
public void setBackedUpStatus(boolean backedUpStatus)
```
    Sets the backup status.
    
    Parameters:
    
    backedUpStatus - The backup status to be set.
  - getBackUpObject
```
public String getBackUpObject()
```
    Returns the distinguished name of the backup object.
  - setBackUpObject
```
public void setBackUpObject(String backUpObject)
```
    Sets the backup object.
    
    Parameters:
    
    backUpObject - The distinguished name to be set.
  - getClearSystemId
```
public String getClearSystemId()
```
    Returns the identifier of the system used by the author of the last request to clear the alarm.
  - setClearSystemId
```
public void setClearSystemId(String clearSystemId)
```
    Sets the identifier of the system used by the author of the last request to clear the alarm.
    
    Parameters:
    
    clearSystemId - The identifier to be set.
  - getClearUserId
```
public String getClearUserId()
```
    Returns the identifier of the author of the last request to clear the alarm.
  - setClearUserId
```
public void setClearUserId(String clearUserId)
```
    Sets the identifier of the author of the last request to clear the alarm.
    
    Parameters:
    
    clearUserId - The identifier to be set.
  - getComments
```
public Object getComments()
```
    Returns the comments.
  - setComments
```
public void setComments(Object comments)
```
    Sets the comments.
    
    Parameters:
    
    comments - The comments to be set.
  - getCorrelatedNotifications
```
public Object getCorrelatedNotifications()
```
    Returns the correlated notifications.
  - setCorrelatedNotifications
```
public void setCorrelatedNotifications(Object notifications)
```
    Sets the correlated notifications.
    
    Parameters:
    
    notifications - The correlated notifications to be set.
  - getManagedObjectClass
```
public String getManagedObjectClass()
```
    Returns the managed object class of the managed object instance in which the alarm occurred.
  - setManagedObjectClass
```
public void setManagedObjectClass(String managedObjectClass)
```
    Sets the managed object class of the managed object instance in which the alarm occurred.
    
    Parameters:
    
    managedObjectClass - The managed object class to be set.
  - getManagedObjectInstance
```
public Object getManagedObjectInstance()
```
    Returns the managed object instance in which the alarm occurred.
  - setManagedObjectInstance
```
public void setManagedObjectInstance(Object managedObjectInstance)
```
    Sets the managed object instance in which the alarm occurred.
    
    Parameters:
    
    managedObjectInstance - The managed object instance to be set.
    
    See Also:
    
    ManagedObjectInstanceAttribute
  - getMonitoredAttributes
```
public Object getMonitoredAttributes()
```
    Returns the monitored attributes.
  - setMonitoredAttributes
```
public void setMonitoredAttributes(Object attributes)
```
    Sets the monitored attributes.
    
    Parameters:
    
    attributes - The monitored attributes to be set.
  - getNotificationId
```
public String getNotificationId()
```
    Returns the identifier of the notification that carries the alarm information.
  - setNotificationId
```
public void setNotificationId(String notificationId)
```
    Sets the identifier of the notification that carries the alarm information.
    
    Parameters:
    
    notificationId - The identifier to be set.
  - getPerceivedSeverity
```
public IltAlarmSeverity getPerceivedSeverity()
```
    Returns the perceived severity. It indicates the relative level of urgency for the end user. Values are defined in IltAlarm.Severity for raw alarms, and in IltAlarm.ImpactSeverity for impact alarms.
    
    See Also:
    
    IltAlarm.Severity, IltAlarm.ImpactSeverity
  - setPerceivedSeverity
```
public void setPerceivedSeverity(IltAlarmSeverity perceivedSeverity)
```
    Sets the perceived severity. It indicates the relative level of urgency for the end user.
    
    Parameters:
    
    perceivedSeverity - The perceived severity to be set.
  - getProbableCause
```
public IltAlarm.ProbableCause getProbableCause()
```
    Returns the probable cause.
  - setProbableCause
```
public void setProbableCause(IltAlarm.ProbableCause probableCause)
```
    Sets the probable cause.
    
    Parameters:
    
    probableCause - The probable cause to be set.
  - getProposedRepairActions
```
public String getProposedRepairActions()
```
    Returns the proposed repair actions.
  - setProposedRepairActions
```
public void setProposedRepairActions(String proposedRepairActions)
```
    Sets the proposed repair actions.
    
    Parameters:
    
    proposedRepairActions - The proposed repair actions to be set.
  - getSpecificProblem
```
public String getSpecificProblem()
```
    Returns the specific problem.
  - setSpecificProblem
```
public void setSpecificProblem(String specificProblem)
```
    Sets the specific problem.
    
    Parameters:
    
    specificProblem - The specific problem to be set.
  - getSystemDN
```
public String getSystemDN()
```
    Returns the distinguished name (DN) of the system that has detected the network event and generated the notification.
  - setSystemDN
```
public void setSystemDN(String systemDN)
```
    Sets the distinguished name (DN) of the system that has detected the network event and generated the notification.
    
    Parameters:
    
    systemDN - The distinguished name to be set.
  - getTrendIndication
```
public IltAlarm.TrendIndication getTrendIndication()
```
    Returns the trend indication. It indicates whether an observed condition is getting better, worse, or not changing.
  - setTrendIndication
```
public void setTrendIndication(IltAlarm.TrendIndication trendIndication)
```
    Sets the trend indication.
    
    Parameters:
    
    trendIndication - The trend indication to be set.
  - getThresholdInfo
```
public Object getThresholdInfo()
```
    Returns the threshold information.
  - setThresholdInfo
```
public void setThresholdInfo(Object thresholdInfo)
```
    Sets the threshold information.
    
    Parameters:
    
    thresholdInfo - The threshold information to be set.
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarmSeverity severity,
                                                  Color normal,
                                                  Color bright,
                                                  Color dark,
                                                  String shortText)
```
    Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 
```
    Parameters:
    
    severity - Alarm severity.
    
    normal - Normal color.
    
    bright - Bright color.
    
    dark - Dark color.
    
    shortText - Short description that represents this severity as an alarm count in the base or inside the alarm balloon.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IltSettings
    
    Deprecated Since:
    
    JTGO 4.5
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarmSeverity severity,
                                                  Color normal,
                                                  Color bright,
                                                  Color dark,
                                                  String shortText,
                                                  String description)
```
    Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color, normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor, bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor, dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation, shortText);
 IltSettings.SetValue("<severity category>.<severity name>.Description, description);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Parameters:
    
    severity - Alarm severity.
    
    normal - Normal color.
    
    bright - Bright color.
    
    dark - Dark color.
    
    shortText - Short description that represents this severity as an alarm count in the base or inside the alarm balloon.
    
    description - Long description that represents this severity in the expanded alarm balloon or in table cells.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IltSettings
    
    Deprecated Since:
    
    JTGO 4.5
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarm.Severity severity,
                                                  Color normal,
                                                  Color bright,
                                                  Color dark,
                                                  char letter)
```
    Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Parameters:
    
    severity - Alarm severity.
    
    normal - Normal color.
    
    bright - Bright color.
    
    dark - Dark color.
    
    letter - Short description that represents this severity as an alarm count in the base or inside the alarm balloon.
    
    Deprecated Since:
    
    JTGO 4.0
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarm.Severity severity,
                                                  Color normal,
                                                  Color bright,
                                                  Color dark,
                                                  char letter,
                                                  String description)
```
    Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 IltSettings.SetValue("<severity category>.<severity name>.Description", description);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Parameters:
    
    severity - Alarm severity.
    
    normal - Normal color.
    
    bright - Bright color.
    
    dark - Dark color.
    
    letter - Short description that represents this severity as an alarm count in the base or inside the alarm balloon.
    
    description - Long description that represents this severity in the expanded alarm balloon or in table cells.
    
    Deprecated Since:
    
    JTGO 4.0
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarm.Severity severity,
                                                  IltKey.Color normalKey,
                                                  Color defaultNormalValue,
                                                  IltKey.Color brightKey,
                                                  Color defaultBrightValue,
                                                  IltKey.Color darkKey,
                                                  Color defaultDarkValue,
                                                  IltKey.String abbreviationKey,
                                                  String defaultAbbreviationValue)
```
    Deprecated. The style API has been replaced by the cascading style sheet mechanism. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    For this new severity, the colors and string are found through IltKeys in the legend of the object to draw. The default values are installed in the IltObject class legend, so that the keys are served for any IltObject.
    
    You can create four new IltKey instances and choose the default values you want. All objects with an alarm of this severity are drawn using these default values, except if you set the keys locally in the object legend.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 IltSettings.SetValue("<severity category>.<severity name>.Description", description);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Deprecated Since:
    
    JTGO 3.0
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarm.Severity severity,
                                                  IltKey.Color normalKey,
                                                  Color defaultNormalValue,
                                                  IltKey.Color brightKey,
                                                  Color defaultBrightValue,
                                                  IltKey.Color darkKey,
                                                  Color defaultDarkValue,
                                                  IltKey.String abbreviationKey,
                                                  String defaultAbbreviationValue,
                                                  IltKey.String expandedKey,
                                                  String defaultExpandedValue)
```
    Deprecated. The style API has been replaced by the cascading style sheet mechanism. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
    Installs a graphical representation mapping for a severity.
    
    For this new severity, the colors and string are found through IltKeys in the legend of the object to draw. The default values are installed in the IltObject class legend, so that the keys are served for any IltObject.
    
    You can create four new IltKey instances and choose the default values you want. All objects with an alarm of this severity are drawn using these default values, except if you set the keys locally in the object legend.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 IltSettings.SetValue("<severity category>.<severity name>.Description", description);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Deprecated Since:
    
    JTGO 3.0
  - SetSeverityMapping
```
@Deprecated
public static void SetSeverityMapping(IltAlarm.Severity severity,
                                                  IlpColorKey normalKey,
                                                  Color defaultNormalValue,
                                                  IlpColorKey brightKey,
                                                  Color defaultBrightValue,
                                                  IlpColorKey darkKey,
                                                  Color defaultDarkValue,
                                                  IlpStringKey abbreviationKey,
                                                  String defaultAbbreviationValue,
                                                  IlpStringKey expandedKey,
                                                  String defaultExpandedValue)
```
    Deprecated. Use IltSettings.SetValue instead.
    Installs a graphical representation mapping for a severity.
    
    For this new severity, the colors and string are found through IltKeys in the legend of the object to draw. The default values are installed in the IltObject class legend, so that the keys are served for any IltObject.
    
    You can create four new IltKey instances and choose the default values you want. All objects with an alarm of this severity are drawn using these default values, except if you set the keys locally in the object legend.
    
    This method corresponds to the following operations:
```
 IltSettings.SetValue("<severity category>.<severity name>.Color", normal);
 IltSettings.SetValue("<severity category>.<severity name>.BrightColor", bright);
 IltSettings.SetValue("<severity category>.<severity name>.DarkColor", dark);
 IltSettings.SetValue("<severity category>.<severity name>.Abbreviation", shortText);
 IltSettings.SetValue("<severity category>.<severity name>.Description", description);
 
```
    For instance, when customizing the IltAlarm.Severity.Critical set the following properties:
```
 IltSettings.SetValue("Alarm.Raw.Critical.Color", normal);
 IltSettings.SetValue("Alarm.Raw.Critical.BrightColor", bright);
 IltSettings.SetValue("Alarm.Raw.Critical.DarkColor", dark);
 IltSettings.SetValue("Alarm.Raw.Critical.Abbreviation", shortText);
 IltSettings.SetValue("Alarm.Raw.Critical.Description", description);
 
```
    Since:
    
    JTGO 3.0
    
    Deprecated Since:
    
    JTGO 3.5
  - InitStyle
```
public static void InitStyle()
```
    Initializes the style.
    
    Internal: do not use!
  - ForceInit
```
public static void ForceInit(ilog.tgo.util.internal.IltForceClassInit object)
```
    For IltSystem.Init
    
    Internal: do not use!

Class IltAlarm

Nested Class Summary

Field Summary

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

Constructor Summary

Method Summary

Methods inherited from class ilog.cpl.model.IlpDefaultObject

Methods inherited from class java.lang.Object

Field Detail

TheIlpClass

GraphicRepresentationAttribute

AckSystemIdAttribute

AckTimeAttribute

AckUserIdAttribute

AdditionalTextAttribute

AlarmAckStateAttribute

AlarmChangedTimeAttribute

AlarmClearedTimeAttribute

AlarmRaisedTimeAttribute

AlarmTypeAttribute

AttributeChangesAttribute

BackedUpStatusAttribute

BackUpObjectAttribute

ClearSystemIdAttribute

CommentsAttribute

CorrelatedNotificationsAttribute

ClearUserIdAttribute

ManagedObjectClassAttribute

ManagedObjectInstanceAttribute

MonitoredAttributesAttribute

NotificationIdAttribute

PerceivedSeverityAttribute

ProbableCauseAttribute

ProposedRepairActionsAttribute

SpecificProblemAttribute

SystemDNAttribute

ThresholdInfoAttribute

TrendIndicationAttribute

Constructor Detail

IltAlarm

IltAlarm

IltAlarm

IltAlarm

IltAlarm

Method Detail

GetAlarmSystem

GetLossOfConnectivityStatePath

GetNotReportingStatePath

GetIlpClass

getAckSystemId

setAckSystemId

getAckTime

setAckTime

getAckUserId

setAckUserId

getAdditionalText

setAdditionalText

getAlarmAckState

setAlarmAckState

getAlarmChangedTime

setAlarmChangedTime

getAlarmClearedTime

setAlarmClearedTime

getAlarmRaisedTime

setAlarmRaisedTime

getAlarmType

setAlarmType

getAttributeChanges

setAttributeChanges

getBackedUpStatus

setBackedUpStatus

getBackUpObject

setBackUpObject

getClearSystemId

setClearSystemId

getClearUserId

setClearUserId

getComments

setComments

getCorrelatedNotifications