Interface MonitorEvent

    • Method Detail

      • getReason

        String getReason()
        Get the value for Reason. (Text that will be stored as the comment for why the event is raised)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isRising

        boolean isRising()
        Get the value for Rising. (Is the event raised when the severity of the montor rises above this severity)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getSeverity

        Long getSeverity()
        Get the value for Severity. (Minimal severity for the event to be raised) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setReason

        void setReason​(String newReason)
        Set the value for Reason. (Text that will be stored as the comment for why the event is raised) This value is optional.
        Parameters:
        newReason - the new value for Reason.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setRising

        void setRising​(boolean newRising)
        Set the value for Rising. (Is the event raised when the severity of the montor rises above this severity)
        Parameters:
        newRising - the new value for Rising.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setSeverity

        void setSeverity​(Long newSeverity)
        Set the value for Severity. (Minimal severity for the event to be raised) This value is mandatory.
        Parameters:
        newSeverity - the new value for Severity. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getEventDefinition

        EventDefinition getEventDefinition()
        Get the EventDefinition.
        Returns:
        EventDefinition
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getLinkableMonitor

        LinkableMonitor getLinkableMonitor()
        Get the LinkableMonitor.
        Returns:
        LinkableMonitor
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.