Package com.redwood.scheduler.api.model

Interface Statistics

    • Method Detail

      • getRefUniqueId

        Long getRefUniqueId()
        Get the value for RefUniqueId. (The entity id for which the statistics are for or null if it is for process definition. Commonly it will contain a process chain call uniqueId for call-related statistics.)
        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.

      • getKeyParameters

        String getKeyParameters()
        Get the value for KeyParameters. (Hash of key parameter names/values)
        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.

      • getCreationTime

        DateTimeZone getCreationTime()
        Get the value for CreationTime. (Timestamp that notes when the object was created.) 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.

      • getLastModificationTime

        DateTimeZone getLastModificationTime()
        Get the value for LastModificationTime. (Timestamp that notes when the object was updated.)
        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.

      • getLastJob

        Long getLastJob()
        Get the value for LastJob. (The id of the last process/call that got executed)
        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.

      • getMinimumRunTime

        Long getMinimumRunTime()
        Get the value for MinimumRunTime. (The minimum value for the runtime.)
        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.

      • getMaximumRunTime

        Long getMaximumRunTime()
        Get the value for MaximumRunTime. (The maximum value for the runtime.)
        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.

      • getSumRuntimes

        BigDecimal getSumRuntimes()
        Get the value for SumRuntimes. (Sum of runtimes stored for calculating averages and stdDeviations.)
        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.

      • getSumCallStartDelays

        BigDecimal getSumCallStartDelays()
        Get the value for SumCallStartDelays. (Sum of call start delays stored for calculating averages and stdDeviations.)
        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.

      • getSumLogFileSizes

        BigDecimal getSumLogFileSizes()
        Get the value for SumLogFileSizes. (Sum of logfile sizes stored for calculating averages and stdDeviations.)
        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.

      • getSumOutFileSizes

        BigDecimal getSumOutFileSizes()
        Get the value for SumOutFileSizes. (Sum of outfile sizes stored for calculating averages and stdDeviations.)
        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.

      • getSumSquaresRuntimes

        BigDecimal getSumSquaresRuntimes()
        Get the value for SumSquaresRuntimes. (Sum of squares of runtimes stored for calculating averages and stdDeviations.)
        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.

      • getSumSquaresCallStartDelays

        BigDecimal getSumSquaresCallStartDelays()
        Get the value for SumSquaresCallStartDelays. (Sum of squares of call start delays stored for calculating averages and stdDeviations.)
        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.

      • getSumSquaresLogFileSizes

        BigDecimal getSumSquaresLogFileSizes()
        Get the value for SumSquaresLogFileSizes. (Sum of squares of logfile sizes stored for calculating averages and stdDeviations.)
        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.

      • getSumSquaresOutFileSizes

        BigDecimal getSumSquaresOutFileSizes()
        Get the value for SumSquaresOutFileSizes. (Sum of squares of outfile sizes stored for calculating averages and stdDeviations.)
        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.

      • getExecuted

        Long getExecuted()
        Get the value for Executed. (The number of processes/calls that ran on the day)
        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.

      • getErrors

        Long getErrors()
        Get the value for Errors. (The number of processes/calls that were in error)
        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.

      • getCompleted

        Long getCompleted()
        Get the value for Completed. (The number of processes/calls that succeeded)
        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.

      • getPercentCompleted

        BigDecimal getPercentCompleted()
        Get the value for PercentCompleted. (The percentage of processes/calls that completed.)
        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.

      • getAverageCallStartDelay

        Long getAverageCallStartDelay()
        Get the value for AverageCallStartDelay. (The average value for the call start delay.) 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.

      • getAverageRunTime

        Long getAverageRunTime()
        Get the value for AverageRunTime. (The average value for the runtime.) 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.

      • getAverageLogFileSize

        Long getAverageLogFileSize()
        Get the value for AverageLogFileSize. (The average value for the log file size.) 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.

      • getAverageOutFileSize

        Long getAverageOutFileSize()
        Get the value for AverageOutFileSize. (The average value for the output file size.) 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.

      • getStdDeviationCallDelay

        BigDecimal getStdDeviationCallDelay()
        Get the value for StdDeviationCallDelay. (The standard deviation for the call start delay.) 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.

      • getStdDeviationRunTime

        BigDecimal getStdDeviationRunTime()
        Get the value for StdDeviationRunTime. (The standard deviation for the runtime.) 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.

      • getStdDeviationLogFile

        BigDecimal getStdDeviationLogFile()
        Get the value for StdDeviationLogFile. (The standard deviation for the log file size.) 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.

      • getStdDeviationOutFile

        BigDecimal getStdDeviationOutFile()
        Get the value for StdDeviationOutFile. (The standard deviation for the output file size.) 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.

      • setRefUniqueId

        void setRefUniqueId​(Long newRefUniqueId)
        Set the value for RefUniqueId. (The entity id for which the statistics are for or null if it is for process definition. Commonly it will contain a process chain call uniqueId for call-related statistics.) This value is optional.
        Parameters:
        newRefUniqueId - the new value for RefUniqueId.
        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.

      • setKeyParameters

        void setKeyParameters​(String newKeyParameters)
        Set the value for KeyParameters. (Hash of key parameter names/values) This value is optional.
        Parameters:
        newKeyParameters - the new value for KeyParameters.
        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.

      • setLastJob

        void setLastJob​(Long newLastJob)
        Set the value for LastJob. (The id of the last process/call that got executed) This value is optional.
        Parameters:
        newLastJob - the new value for LastJob.
        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.

      • setMinimumRunTime

        void setMinimumRunTime​(Long newMinimumRunTime)
        Set the value for MinimumRunTime. (The minimum value for the runtime.) This value is optional.
        Parameters:
        newMinimumRunTime - the new value for MinimumRunTime.
        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.

      • setMaximumRunTime

        void setMaximumRunTime​(Long newMaximumRunTime)
        Set the value for MaximumRunTime. (The maximum value for the runtime.) This value is optional.
        Parameters:
        newMaximumRunTime - the new value for MaximumRunTime.
        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.

      • setSumRuntimes

        void setSumRuntimes​(BigDecimal newSumRuntimes)
        Set the value for SumRuntimes. (Sum of runtimes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumRuntimes - the new value for SumRuntimes.
        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.

      • setSumCallStartDelays

        void setSumCallStartDelays​(BigDecimal newSumCallStartDelays)
        Set the value for SumCallStartDelays. (Sum of call start delays stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumCallStartDelays - the new value for SumCallStartDelays.
        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.

      • setSumLogFileSizes

        void setSumLogFileSizes​(BigDecimal newSumLogFileSizes)
        Set the value for SumLogFileSizes. (Sum of logfile sizes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumLogFileSizes - the new value for SumLogFileSizes.
        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.

      • setSumOutFileSizes

        void setSumOutFileSizes​(BigDecimal newSumOutFileSizes)
        Set the value for SumOutFileSizes. (Sum of outfile sizes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumOutFileSizes - the new value for SumOutFileSizes.
        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.

      • setSumSquaresRuntimes

        void setSumSquaresRuntimes​(BigDecimal newSumSquaresRuntimes)
        Set the value for SumSquaresRuntimes. (Sum of squares of runtimes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumSquaresRuntimes - the new value for SumSquaresRuntimes.
        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.

      • setSumSquaresCallStartDelays

        void setSumSquaresCallStartDelays​(BigDecimal newSumSquaresCallStartDelays)
        Set the value for SumSquaresCallStartDelays. (Sum of squares of call start delays stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumSquaresCallStartDelays - the new value for SumSquaresCallStartDelays.
        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.

      • setSumSquaresLogFileSizes

        void setSumSquaresLogFileSizes​(BigDecimal newSumSquaresLogFileSizes)
        Set the value for SumSquaresLogFileSizes. (Sum of squares of logfile sizes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumSquaresLogFileSizes - the new value for SumSquaresLogFileSizes.
        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.

      • setSumSquaresOutFileSizes

        void setSumSquaresOutFileSizes​(BigDecimal newSumSquaresOutFileSizes)
        Set the value for SumSquaresOutFileSizes. (Sum of squares of outfile sizes stored for calculating averages and stdDeviations.) This value is optional.
        Parameters:
        newSumSquaresOutFileSizes - the new value for SumSquaresOutFileSizes.
        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.

      • setExecuted

        void setExecuted​(Long newExecuted)
        Set the value for Executed. (The number of processes/calls that ran on the day) This value is optional.
        Parameters:
        newExecuted - the new value for Executed.
        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.

      • setErrors

        void setErrors​(Long newErrors)
        Set the value for Errors. (The number of processes/calls that were in error) This value is optional.
        Parameters:
        newErrors - the new value for Errors.
        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.

      • setCompleted

        void setCompleted​(Long newCompleted)
        Set the value for Completed. (The number of processes/calls that succeeded) This value is optional.
        Parameters:
        newCompleted - the new value for Completed.
        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.

      • setPercentCompleted

        void setPercentCompleted​(BigDecimal newPercentCompleted)
        Set the value for PercentCompleted. (The percentage of processes/calls that completed.) This value is optional.
        Parameters:
        newPercentCompleted - the new value for PercentCompleted.
        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.

      • setKeyParameters

        void setKeyParameters​(Map<String,​String> keyParameters)
        Set the keyParameters
        Parameters:
        keyParameters - A map of key parameters names/values, with both names and values as strings.

      • getObjectDefinition

        ObjectDefinition getObjectDefinition()
        Get the ObjectDefinition.
        Returns:
        ObjectDefinition
        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.

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

      • getLastModifierSubject

        Subject getLastModifierSubject()
        Get the LastModifierSubject.
        Returns:
        LastModifierSubject
        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.

      • setObjectDefinition

        void setObjectDefinition​(ObjectDefinition newObjectDefinition)
        Set the value for ObjectDefinition. This value is mandatory.
        Parameters:
        newObjectDefinition - is the object to set ObjectDefinition to. The ObjectDefinition for the Job Statistics If this is null, then the object cannot be persisted.