Interface NodeReconciliationAlarmMBean

  • All Known Implementing Classes:
    NodeReconciliationAlarm

    public interface NodeReconciliationAlarmMBean
    NodeReconciliationAlarmMBean is the generic interface for providing alarm services by maintaning the alarm object.
    • Method Detail

      • setRaiseAlarmObject

        void setRaiseAlarmObject​(List<String> raiseAlarmObject)
        This method is called to set the list of raiseAlarmObjets. This includes the alarm objects which are to be raised
        Parameters:
        raiseAlarmObject - holds the list of alarm objects
      • getRaiseAlarmObject

        List<String> getRaiseAlarmObject()
        This method is called to retrieve the list of alarm objects which are to be raised.
        Returns:
        List of string containing the alarm objects
      • setClearAlarmObject

        void setClearAlarmObject​(List<String> clearAlarmObject)
        This method is called to set the list of alarm objects to be cleared.
        Parameters:
        clearAlarmObject - maintains the list of clearable alarm objects
      • getClearAlarmObject

        List<String> getClearAlarmObject()
        This method is called to retrieve the list of the alarm objects to be cleared.
        Returns:
        List of clearable alarm objects
      • raiseAlarm

        void raiseAlarm​(String alarmName,
                        String additionalText,
                        String source)
        This method is called to raise the alarm with the specified alarm name.
        Parameters:
        alarmName - name of the alarm to be raised
        additionalText - description of alarm event
        source - source of alarm
      • clearAlarm

        void clearAlarm​(String alarmName,
                        String additionalText,
                        String source)
        This method is called to clear the raised alarm with the specified alarm name.
        Parameters:
        alarmName - name of the alarm to be cleared
        additionalText - description of alarm event
        source - source of alarm