Package com.unboundid.directory.sdk.common.types

Interface AlertNotification

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.Object,​java.lang.Object> getAdditionalInformation()
      Retrieves a map of objects containing additional information for this alert notification.
      java.lang.String getAlertGeneratorClassName()
      Retrieves the name of the class that generated this alert notification.
      java.lang.String getAlertID()
      Retrieves the unique ID assigned to this alert notification.
      java.lang.String getAlertMessage()
      Retrieves the message for this alert notification, which may contain specific information about the error, warning, or event that triggered the alert.
      AlertSeverity getAlertSeverity()
      Retrieves the severity for this alert notification.
      java.util.Date getAlertTime()
      Retrieves the time that this alert notification was generated.
      java.lang.String getAlertTypeDescription()
      Retrieves a description of the alert type for this alert notification.
      java.lang.String getAlertTypeName()
      Retrieves the name of the alert type for this alert notification.
      java.lang.String getAlertTypeOID()
      Retrieves the OID of the alert type for this alert notification.
      java.lang.String getAlertTypeSummary()
      Retrieves a short summary of the alert type for this alert notification.
      java.lang.String toString()
      Retrieves a string representation of this alert notification.

    • Method Detail

      • getAlertID

        java.lang.String getAlertID()
        Retrieves the unique ID assigned to this alert notification.
        Returns:
        The unique ID assigned to this alert notification.

      • getAlertTime

        java.util.Date getAlertTime()
        Retrieves the time that this alert notification was generated.
        Returns:
        The time that this alert notification was generated.

      • getAlertGeneratorClassName

        java.lang.String getAlertGeneratorClassName()
        Retrieves the name of the class that generated this alert notification.
        Returns:
        The name of the class that generated this alert notification.

      • getAlertTypeName

        java.lang.String getAlertTypeName()
        Retrieves the name of the alert type for this alert notification.
        Returns:
        The name of the alert type for this alert notification.

      • getAlertTypeSummary

        java.lang.String getAlertTypeSummary()
        Retrieves a short summary of the alert type for this alert notification. It will generally use headline-style capitalization.
        Returns:
        A short summary of the alert type for this alert notification.

      • getAlertTypeDescription

        java.lang.String getAlertTypeDescription()
        Retrieves a description of the alert type for this alert notification. It may be longer than the alert type summary and will use a more prose-style capitalization.
        Returns:
        A description of the alert type for this alert notification.

      • getAlertTypeOID

        java.lang.String getAlertTypeOID()
        Retrieves the OID of the alert type for this alert notification.
        Returns:
        The OID of the alert type for this alert notification.

      • getAlertSeverity

        AlertSeverity getAlertSeverity()
        Retrieves the severity for this alert notification.
        Returns:
        The severity for this alert notification.

      • getAlertMessage

        java.lang.String getAlertMessage()
        Retrieves the message for this alert notification, which may contain specific information about the error, warning, or event that triggered the alert.
        Returns:
        The message for this alert notification.

      • getAdditionalInformation

        java.util.Map<java.lang.Object,​java.lang.Object> getAdditionalInformation()
        Retrieves a map of objects containing additional information for this alert notification.
        Returns:
        Map of objects for this alert notification.

      • toString

        java.lang.String toString()
        Retrieves a string representation of this alert notification.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this alert notification.