Package com.streambase.liveview.client.alert

Interface AlertRule

  • public interface AlertRule
    Represents an alert rule suitable for residing in a TIBCO Live Datamart server. Properties managed by the server include, but are not limited to, the id, enablement and validation status.
    Since:
    2.0

    • Method Detail

      • getStatusMessage

        String getStatusMessage()
        Gets the value of the statusMessage property.
        Returns:
        possible object is String

      • setStatusMessage

        void setStatusMessage​(String value)
        Sets the value of the statusMessage property.
        Parameters:
        value - allowed object is String

      • getCronString

        String getCronString()
        Gets the value of the cronString property.
        Returns:
        the String representing the cron schedule for the cron based AlertRule.

      • setCronString

        void setCronString​(String value)
        Sets the value of the cronString property which is a cron expression. Also changes the alert type from default to AlertType=CRON alert. A cron expression is a string consisting of six or seven subexpressions (fields) that describe individual details of the schedule. These fields, separated by white space, can contain any of the allowed values with various combinations of the allowed characters for that field. 
         Expressions Allowed Fields and Values
 1) Seconds: 0-59 or Allowed special characters(, - * /)
 2) Minutes: 0-59 or Allowed special characters(, - * /)
 3) Hours: 0-23 or Allowed special characters(, - * /)
 4) Day of month: 1-31 or Allowed special characters(, - * ? / L W C)
 5) Month: 0-11 or JAN-DEC or Allowed special characters(, - * /)
 6) Day of week: 1-7 or SUN-SAT or Allowed special characters(, - * ? / L C #)
 7) Year: empty or 1970-2099 or Allowed special characters(, - * /)
 
 e.g: 
 0 15 10 * * ? 2005
 Fire the alert at 10:15 AM every day during the year 2005
        Parameters:
        value - allowed object is String

      • getAlertQueryConfig

        QueryConfig getAlertQueryConfig()
        Gets the value of the alertQueryConfig property.
        Returns:
        possible object is Query

      • setAlertQueryConfig

        void setAlertQueryConfig​(QueryConfig queryConfig)
        Sets the value of the alertQueryConfig property.
        Parameters:
        queryConfig - allowed object is QueryConfig

      • getDescription

        String getDescription()
        Gets the value of the description property.
        Returns:
        possible object is String

      • setDescription

        void setDescription​(String value)
        Sets the value of the description property.
        Parameters:
        value - allowed object is String

      • getMessageTemplate

        String getMessageTemplate()
        Gets the value of the messageTemplate property.
        Returns:
        possible object is String

      • setMessageTemplate

        void setMessageTemplate​(String value)
        Sets the value of the messageTemplate property.
        Parameters:
        value - allowed object is String

      • getName

        String getName()
        Gets the value of the name property.
        Returns:
        possible object is String

      • setName

        void setName​(String value)
        Sets the value of the name property.
        Parameters:
        value - allowed object is String

      • getSeverity

        Integer getSeverity()
        Gets the value of the severity property.
        Returns:
        possible object is Integer

      • setSeverity

        void setSeverity​(int value)
        Sets the value of the severity property.
        Parameters:
        value - allowed object is Integer

      • getQuiescence

        Integer getQuiescence()
        Gets the value of the quiescence property.
        Returns:
        the Integer value for the quiescence property.

      • setQuiescence

        void setQuiescence​(int value)
        Sets the value of the quiescence property.
        Parameters:
        value - the value to set for the quiescence property.

      • isEnabled

        boolean isEnabled()
        Gets the value of the enabled property.
        Returns:
        possible object is Boolean.

      • setEnabled

        void setEnabled​(boolean value)
        Sets the value of the enabled property.
        Parameters:
        value - allowed object is Boolean

      • getOwner

        String getOwner()
        Gets the value of the owner property. The special value * means "all users."
        Returns:
        possible object is String

      • setOwner

        void setOwner​(String value)
        Sets the value of the owner property. The special value * means "all users." Note that since 2.2.3, if authentication is enabled, the user provided value is ignored and replaced with the currently authenticated user.
        Parameters:
        value - allowed object is String

      • getCreated

        Calendar getCreated()
        Gets the value of the created property.
        Returns:
        possible object is Calendar

      • getLastUpdated

        Calendar getLastUpdated()
        Gets the value of the lastUpdated property.
        Returns:
        possible object is Calendar

      • getGUID

        String getGUID()
        Gets the value of the GUID property
        Returns:
        possible object is String
        Since:
        10.3

      • isValid

        boolean isValid()
        Gets the value of the status property.
        Returns:
        true if this alert is valid

      • setIsValid

        void setIsValid​(boolean isValid)
        Sets the value of the status property.
        Parameters:
        isValid - allowed object is StatusType

      • getPersistedVersion

        Integer getPersistedVersion()
        Gets the value of the persistedVersion property.
        Returns:
        possible object is Integer

      • setPersistedVersion

        void setPersistedVersion​(Integer value)
        Sets the value of the persistedVersion property.
        Parameters:
        value - allowed object is Integer

      • getAlertGroup

        String getAlertGroup()
        Gets the value of the alertGroup property.
        Returns:
        possible object is String

      • setAlertGroup

        void setAlertGroup​(String value)
        Sets the value of the alertGroup property.
        Parameters:
        value - allowed object is String

      • getActions

        List<AlertRuleAction> getActions()
        This gets the live list of actions, so you could remove or rearrange these, and the changes will be saved if you save the Alert. Use any of the factory methods below to create one of the action types, and that will also add it to the list.
        Returns:
        the list of Actions

      • newExecuteJavaAction

        ExecuteJavaAction newExecuteJavaAction()
        Creates a new ExecuteJavaAction and adds it to the end of the list of Actions
        Returns:
        the newly created ExecuteJavaAction

      • newExecuteOSCommandAction

        ExecuteOSCommandAction newExecuteOSCommandAction()
        Creates a new ExecuteOSCommandAction and adds it to the end of the list of Actions
        Returns:
        the newly created ExecuteOSCommandAction

      • newIssueDeleteQueryAction

        IssueDeleteQueryAction newIssueDeleteQueryAction()
        Creates a new IssueDeleteQueryAction and adds it to the end of the list of Actions
        Returns:
        the newly created IssueDeleteQueryAction

      • newPublishAlertAction

        PublishAlertAction newPublishAlertAction()
        Creates a new PublishAlertAction and adds it to the end of the list of Actions
        Returns:
        the newly created PublishAlertAction

      • newSendEmailAction

        SendEmailAction newSendEmailAction()
        Creates a new SendEmailAction and adds it to the end of the list of Actions
        Returns:
        the newly created SendEmailAction

      • newInvokeHTTPAction

        InvokeHTTPAction newInvokeHTTPAction()
        Creates a new InvokeHTTPAction and adds it to the end of the list of Actions
        Returns:
        the newly created InvokeHTTPAction

      • newSendTupleAction

        SendTupleAction newSendTupleAction()
        Creates a new SendTupleAction and adds it to the end of the list of Actions
        Returns:
        the newly created SendTupleAction

      • newLVPublishAlertAction

        LVPublishAlertAction newLVPublishAlertAction()
        Creates a new LVPublishAlertAction and adds it to the end of the list of Actions
        Returns:
        the newly created LVPublishAlertAction