Interface AlertSource

    • Method Detail

      • getEscalationExpression

        String getEscalationExpression()
        Get the value for EscalationExpression. (The (optional) alert escalation expression. If this is set, then the expression is evaluated. If the resulting channel exists, it is used for escalation, otherwise the default escalation channel is used.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getOperatorMessageExpression

        String getOperatorMessageExpression()
        Get the value for OperatorMessageExpression. (The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getOperatorMessageReplyExpression

        String getOperatorMessageReplyExpression()
        Get the value for OperatorMessageReplyExpression. (The operator message reply expression. If this is set, then the expression is evaluated, and the result is used as the allowed responses to the operator message. If not set, a source specific default is used.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getTimeWindowStatus

        TimeWindowStatus getTimeWindowStatus()
        Get the value for TimeWindowStatus. (The status of the time window (open or closed).) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getAddress

        String getAddress()
        Get the value for Address. (The (optional) address to send this alert to)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Enable/disable the alert source)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getValidity

        Validity getValidity()
        Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEscalationExpression

        void setEscalationExpression​(String newEscalationExpression)
        Set the value for EscalationExpression. (The (optional) alert escalation expression. If this is set, then the expression is evaluated. If the resulting channel exists, it is used for escalation, otherwise the default escalation channel is used.) This value is optional.
        Parameters:
        newEscalationExpression - the new value for EscalationExpression.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setOperatorMessageExpression

        void setOperatorMessageExpression​(String newOperatorMessageExpression)
        Set the value for OperatorMessageExpression. (The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.) This value is optional.
        Parameters:
        newOperatorMessageExpression - the new value for OperatorMessageExpression.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setOperatorMessageReplyExpression

        void setOperatorMessageReplyExpression​(String newOperatorMessageReplyExpression)
        Set the value for OperatorMessageReplyExpression. (The operator message reply expression. If this is set, then the expression is evaluated, and the result is used as the allowed responses to the operator message. If not set, a source specific default is used.) This value is optional.
        Parameters:
        newOperatorMessageReplyExpression - the new value for OperatorMessageReplyExpression.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setTimeWindowStatus

        void setTimeWindowStatus​(TimeWindowStatus newTimeWindowStatus)
        Set the value for TimeWindowStatus. (The status of the time window (open or closed).) This value is mandatory.
        Parameters:
        newTimeWindowStatus - the new value for TimeWindowStatus. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setAddress

        void setAddress​(String newAddress)
        Set the value for Address. (The (optional) address to send this alert to) This value is optional.
        Parameters:
        newAddress - the new value for Address.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Enable/disable the alert source)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDefaultAlertEscalation

        void setDefaultAlertEscalation​(AlertEscalation newDefaultAlertEscalation)
        Set the value for DefaultAlertEscalation. This value is optional.
        Parameters:
        newDefaultAlertEscalation - is the object to set DefaultAlertEscalation to. The default escalation channel for this alert source.
      • setTimeWindow

        void setTimeWindow​(TimeWindow newTimeWindow)
        Set the value for TimeWindow. This value is optional.
        Parameters:
        newTimeWindow - is the object to set TimeWindow to. The time window during which this alert source is active.
      • setTimeZone

        void setTimeZone​(TimeZone newTimeZone)
        Set the value for TimeZone. This value is optional.
        Parameters:
        newTimeZone - is the object to set TimeZone to. The timezone for the timewindowinterval