Interface JobRuntimeLimit

    • Method Detail

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

        Long getLimitDuration()
        Get the value for LimitDuration. (The calculated runtime limit in milliseconds since the job runstart.)
        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.
      • getLimitTime

        DateTimeZone getLimitTime()
        Get the value for LimitTime. (The calculated timestamp.)
        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.
      • 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.
      • setLimitDuration

        void setLimitDuration​(Long newLimitDuration)
        Set the value for LimitDuration. (The calculated runtime limit in milliseconds since the job runstart.) This value is optional.
        Parameters:
        newLimitDuration - the new value for LimitDuration.
        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.
      • setLimitTime

        void setLimitTime​(DateTimeZone newLimitTime)
        Set the value for LimitTime. (The calculated timestamp.) This value is optional.
        Parameters:
        newLimitTime - the new value for LimitTime.
        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.
      • 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.
      • getTimeZone

        TimeZone getTimeZone()
        Get the TimeZone.
        Returns:
        TimeZone
        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.
      • getJob

        Job getJob()
        Get the Job.
        Returns:
        Job
        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?
      • setTimeZone

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