Package com.redwood.scheduler.api.model

Interface JobDefinitionRuntimeLimit

    • Method Detail

      • getERTPlusOrMinusType

        ERTPlusOrMinusType getERTPlusOrMinusType()
        Get the value for ERTPlusOrMinusType. (Add or subtract the offset?) 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.

      • getMaxMinType

        MaxMinType getMaxMinType()
        Get the value for MaxMinType. (Maximum or minimum runtime limit?) 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.

      • getLimitValue

        Long getLimitValue()
        Get the value for LimitValue. (Depending on the LimitType and the CalculatedLimitType. For LimitType Fixed, it is the fixed runtime limit for the job in millis. For the LimitType Offset, it is the offset to the average runtime in millis. For LimitType Calculated it is the offset to the average runtime in number of percentages of the average runtime (when CalculatedLimitType = Percent) or the number of standard deviations (when CalculatedLimitType = StdDev). )
        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.

      • getLimitExpression

        String getLimitExpression()
        Get the value for LimitExpression. (The REL Expression, which should evaluate to a the runtime limit in millis (duration), or a fixed limit as DateTimeZone. )
        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.

      • getLimitType

        RuntimeLimitType getLimitType()
        Get the value for LimitType. (Indicates the type of the limit value Fixed, Offset, Calculated or Expression.) 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.

      • getCalculatedLimitType

        CalculatedRuntimeLimitType getCalculatedLimitType()
        Get the value for CalculatedLimitType. (Indicates the type of the calculated limit from the ERT: (P)ercent, (S)tdDev.) 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.

      • isKillJob

        boolean isKillJob()
        Get the value for KillJob. (Kill the job if the maximum limit or set the job to error if the minimum limit is reached?)
        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.

      • setERTPlusOrMinusType

        void setERTPlusOrMinusType​(ERTPlusOrMinusType newERTPlusOrMinusType)
        Set the value for ERTPlusOrMinusType. (Add or subtract the offset?) This value is mandatory.
        Parameters:
        newERTPlusOrMinusType - the new value for ERTPlusOrMinusType. 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.

      • setMaxMinType

        void setMaxMinType​(MaxMinType newMaxMinType)
        Set the value for MaxMinType. (Maximum or minimum runtime limit?) This value is mandatory.
        Parameters:
        newMaxMinType - the new value for MaxMinType. 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.

      • setLimitValue

        void setLimitValue​(Long newLimitValue)
        Set the value for LimitValue. (Depending on the LimitType and the CalculatedLimitType. For LimitType Fixed, it is the fixed runtime limit for the job in millis. For the LimitType Offset, it is the offset to the average runtime in millis. For LimitType Calculated it is the offset to the average runtime in number of percentages of the average runtime (when CalculatedLimitType = Percent) or the number of standard deviations (when CalculatedLimitType = StdDev). ) This value is optional.
        Parameters:
        newLimitValue - the new value for LimitValue.
        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.

      • setLimitExpression

        void setLimitExpression​(String newLimitExpression)
        Set the value for LimitExpression. (The REL Expression, which should evaluate to a the runtime limit in millis (duration), or a fixed limit as DateTimeZone. ) This value is optional.
        Parameters:
        newLimitExpression - the new value for LimitExpression.
        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.

      • setLimitType

        void setLimitType​(RuntimeLimitType newLimitType)
        Set the value for LimitType. (Indicates the type of the limit value Fixed, Offset, Calculated or Expression.) This value is mandatory.
        Parameters:
        newLimitType - the new value for LimitType. 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.

      • setCalculatedLimitType

        void setCalculatedLimitType​(CalculatedRuntimeLimitType newCalculatedLimitType)
        Set the value for CalculatedLimitType. (Indicates the type of the calculated limit from the ERT: (P)ercent, (S)tdDev.) This value is mandatory.
        Parameters:
        newCalculatedLimitType - the new value for CalculatedLimitType. 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.

      • setKillJob

        void setKillJob​(boolean newKillJob)
        Set the value for KillJob. (Kill the job if the maximum limit or set the job to error if the minimum limit is reached?)
        Parameters:
        newKillJob - the new value for KillJob.
        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.

      • getJobDefinition

        JobDefinition getJobDefinition()
        Get the JobDefinition.
        Returns:
        JobDefinition
        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.

      • 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.

      • getAdHocAlertSource

        AdHocAlertSource getAdHocAlertSource()
        Get the AdHocAlertSource.
        Returns:
        AdHocAlertSource
        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.

      • setEventDefinition

        void setEventDefinition​(EventDefinition newEventDefinition)
        Set the value for EventDefinition. This value is optional.
        Parameters:
        newEventDefinition - is the object to set EventDefinition to. Which EventDefinition to be raised if the runtime limit is reached?

      • setAdHocAlertSource

        void setAdHocAlertSource​(AdHocAlertSource newAdHocAlertSource)
        Set the value for AdHocAlertSource. This value is optional.
        Parameters:
        newAdHocAlertSource - is the object to set AdHocAlertSource to. Which AlertSource to be raised if the runtime limit is reached?