Interface AlarmIdentifier


public interface AlarmIdentifier
Uniquely identifies an alarm by specifying the AlarmingResource that caused the alarm and the AlarmType, specifying the type of the alarm (usually the type of failure that occurred at the resource).
Since:
5.2.0
  • Field Details

  • Method Details

    • getResource

      AlarmingResource getResource()
      Returns the resource component of this identifier.
      Returns:
      the AlarmingResource
    • getAlarmType

      AlarmType getAlarmType()
      Returns the alarm type component of this identifier.
      Returns:
      the AlarmType
    • getQualifier

      String getQualifier()
      Returns the qualifier component of this alarm. If no qualifier has been explicitly specified for the alarm, the string "none" is returned.
      Returns:
      the qualifier as a String
    • asUniqueString

      String asUniqueString()
      Returns a unique identifier for this alarm. An alarm is considered unique when the alarming resource, the node raising the alarm and the alarm type are the same.
      Returns:
      A string representing this alarm