Package com.redwood.scheduler.api.model

Interface StatisticsSample

    • Method Detail

      • getObjName

        @Deprecated
String getObjName()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for ObjName. (The name of the object) 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.

      • getJobDefinitionId

        @Deprecated
Long getJobDefinitionId()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for JobDefinitionId. (Deprecated Class, do not use. The UniqueId of the objects Job Definition) 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.

      • getMasterJobDefinitionId

        @Deprecated
Long getMasterJobDefinitionId()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for MasterJobDefinitionId. (Deprecated Class, do not use. The UniqueId of the objects Master Job Definition) 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.

      • getSampleDate

        @Deprecated
DateTimeZone getSampleDate()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for SampleDate. (Deprecated Class, do not use. The date for which the sample 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.

      • getDayOfYear

        @Deprecated
Long getDayOfYear()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for DayOfYear. (Deprecated Class, do not use. The day of the year for which the sample was created.)

        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.

      • getRequestedStartTime

        @Deprecated
DateTimeZone getRequestedStartTime()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for RequestedStartTime. (Deprecated Class, do not use. The time that the user requested the Job/Call to start.)

        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

        @Deprecated
Long getExecuted()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for Executed. (Deprecated Class, do not use. The number of jobs/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

        @Deprecated
Long getErrors()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for Errors. (Deprecated Class, do not use. The number of jobs/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

        @Deprecated
Long getCompleted()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for Completed. (Deprecated Class, do not use. The number of jobs/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.

      • getLastCompleted

        @Deprecated
Long getLastCompleted()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for LastCompleted. (Deprecated Class, do not use. The id of the last job/call 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.

      • getLastNotCompleted

        @Deprecated
Long getLastNotCompleted()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for LastNotCompleted. (Deprecated Class, do not use. The id of the last job/call that didn't succeed)

        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

        @Deprecated
BigDecimal getPercentCompleted()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for PercentCompleted. (Deprecated Class, do not use. The percentage of calls/jobs 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

        @Deprecated
Long getAverageCallStartDelay()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for AverageCallStartDelay. (Deprecated Class, do not use. How long the average call took to start.)

        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

        @Deprecated
Long getAverageRunTime()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for AverageRunTime. (Deprecated Class, do not use. The average runtime of this call/job in milliseconds.)

        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

        @Deprecated
Long getAverageLogFileSize()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for AverageLogFileSize. (Deprecated Class, do not use. The average size of the log files generated by this job in bytes.)

        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

        @Deprecated
Long getAverageOutFileSize()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for AverageOutFileSize. (Deprecated Class, do not use. The average size of the output files generated by this job in bytes.)

        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

        @Deprecated
BigDecimal getStdDeviationCallDelay()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StdDeviationCallDelay. (Deprecated Class, do not use. The square root of the call delay variance)

        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

        @Deprecated
BigDecimal getStdDeviationRuntime()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StdDeviationRuntime. (Deprecated Class, do not use. The square root of the runtime variance)

        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

        @Deprecated
BigDecimal getStdDeviationLogFile()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StdDeviationLogFile. (Deprecated Class, do not use. The square root of the log file size variance)

        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

        @Deprecated
BigDecimal getStdDeviationOutFile()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StdDeviationOutFile. (Deprecated Class, do not use. The square root of the output file size variance)

        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.

      • getStepId

        @Deprecated
Long getStepId()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StepId. (Deprecated Class, do not use. The Step ID for this Job if it is a JobChainStep. Null if not a JobChainStep)

        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.

      • getStepSequenceNumber

        @Deprecated
Long getStepSequenceNumber()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for StepSequenceNumber. (Deprecated Class, do not use. The sequence number of the Job if it is of type JobChainStep. Null if not a JobChainStep)

        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.

      • getCallId

        @Deprecated
Long getCallId()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for CallId. (Deprecated Class, do not use. The Call ID for this Job if it is a JobChainCall. Null if not a JobChainCall)

        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.

      • getCallSequenceNumber

        @Deprecated
Long getCallSequenceNumber()
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Get the value for CallSequenceNumber. (Deprecated Class, do not use. The sequence number of the Call if it is of type JobChainCall. Null if not a JobChainCall)

        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.

      • setObjName

        @Deprecated
void setObjName​(String newObjName)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for ObjName. (The name of the object) This value is mandatory.

        Parameters:
        newObjName - the new value for ObjName. 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.

      • setJobDefinitionId

        @Deprecated
void setJobDefinitionId​(Long newJobDefinitionId)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for JobDefinitionId. (Deprecated Class, do not use. The UniqueId of the objects Job Definition) This value is mandatory.

        Parameters:
        newJobDefinitionId - the new value for JobDefinitionId. 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.

      • setMasterJobDefinitionId

        @Deprecated
void setMasterJobDefinitionId​(Long newMasterJobDefinitionId)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for MasterJobDefinitionId. (Deprecated Class, do not use. The UniqueId of the objects Master Job Definition) This value is mandatory.

        Parameters:
        newMasterJobDefinitionId - the new value for MasterJobDefinitionId. 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.

      • setSampleDate

        @Deprecated
void setSampleDate​(DateTimeZone newSampleDate)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for SampleDate. (Deprecated Class, do not use. The date for which the sample was created.) This value is mandatory.

        Parameters:
        newSampleDate - the new value for SampleDate. 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.

      • setDayOfYear

        @Deprecated
void setDayOfYear​(Long newDayOfYear)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for DayOfYear. (Deprecated Class, do not use. The day of the year for which the sample was created.) This value is optional.

        Parameters:
        newDayOfYear - the new value for DayOfYear.
        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.

      • setRequestedStartTime

        @Deprecated
void setRequestedStartTime​(DateTimeZone newRequestedStartTime)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for RequestedStartTime. (Deprecated Class, do not use. The time that the user requested the Job/Call to start.) This value is optional.

        Parameters:
        newRequestedStartTime - the new value for RequestedStartTime.
        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

        @Deprecated
void setExecuted​(Long newExecuted)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for Executed. (Deprecated Class, do not use. The number of jobs/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

        @Deprecated
void setErrors​(Long newErrors)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for Errors. (Deprecated Class, do not use. The number of jobs/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

        @Deprecated
void setCompleted​(Long newCompleted)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for Completed. (Deprecated Class, do not use. The number of jobs/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.

      • setLastCompleted

        @Deprecated
void setLastCompleted​(Long newLastCompleted)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for LastCompleted. (Deprecated Class, do not use. The id of the last job/call that succeeded) This value is optional.

        Parameters:
        newLastCompleted - the new value for LastCompleted.
        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.

      • setLastNotCompleted

        @Deprecated
void setLastNotCompleted​(Long newLastNotCompleted)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for LastNotCompleted. (Deprecated Class, do not use. The id of the last job/call that didn't succeed) This value is optional.

        Parameters:
        newLastNotCompleted - the new value for LastNotCompleted.
        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

        @Deprecated
void setPercentCompleted​(BigDecimal newPercentCompleted)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for PercentCompleted. (Deprecated Class, do not use. The percentage of calls/jobs 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.

      • setAverageCallStartDelay

        @Deprecated
void setAverageCallStartDelay​(Long newAverageCallStartDelay)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for AverageCallStartDelay. (Deprecated Class, do not use. How long the average call took to start.) This value is optional.

        Parameters:
        newAverageCallStartDelay - the new value for AverageCallStartDelay.
        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.

      • setAverageRunTime

        @Deprecated
void setAverageRunTime​(Long newAverageRunTime)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for AverageRunTime. (Deprecated Class, do not use. The average runtime of this call/job in milliseconds.) This value is optional.

        Parameters:
        newAverageRunTime - the new value for AverageRunTime.
        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.

      • setAverageLogFileSize

        @Deprecated
void setAverageLogFileSize​(Long newAverageLogFileSize)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for AverageLogFileSize. (Deprecated Class, do not use. The average size of the log files generated by this job in bytes.) This value is optional.

        Parameters:
        newAverageLogFileSize - the new value for AverageLogFileSize.
        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.

      • setAverageOutFileSize

        @Deprecated
void setAverageOutFileSize​(Long newAverageOutFileSize)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for AverageOutFileSize. (Deprecated Class, do not use. The average size of the output files generated by this job in bytes.) This value is optional.

        Parameters:
        newAverageOutFileSize - the new value for AverageOutFileSize.
        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.

      • setStdDeviationCallDelay

        @Deprecated
void setStdDeviationCallDelay​(BigDecimal newStdDeviationCallDelay)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StdDeviationCallDelay. (Deprecated Class, do not use. The square root of the call delay variance) This value is optional.

        Parameters:
        newStdDeviationCallDelay - the new value for StdDeviationCallDelay.
        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.

      • setStdDeviationRuntime

        @Deprecated
void setStdDeviationRuntime​(BigDecimal newStdDeviationRuntime)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StdDeviationRuntime. (Deprecated Class, do not use. The square root of the runtime variance) This value is optional.

        Parameters:
        newStdDeviationRuntime - the new value for StdDeviationRuntime.
        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.

      • setStdDeviationLogFile

        @Deprecated
void setStdDeviationLogFile​(BigDecimal newStdDeviationLogFile)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StdDeviationLogFile. (Deprecated Class, do not use. The square root of the log file size variance) This value is optional.

        Parameters:
        newStdDeviationLogFile - the new value for StdDeviationLogFile.
        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.

      • setStdDeviationOutFile

        @Deprecated
void setStdDeviationOutFile​(BigDecimal newStdDeviationOutFile)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StdDeviationOutFile. (Deprecated Class, do not use. The square root of the output file size variance) This value is optional.

        Parameters:
        newStdDeviationOutFile - the new value for StdDeviationOutFile.
        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.

      • setStepId

        @Deprecated
void setStepId​(Long newStepId)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StepId. (Deprecated Class, do not use. The Step ID for this Job if it is a JobChainStep. Null if not a JobChainStep) This value is optional.

        Parameters:
        newStepId - the new value for StepId.
        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.

      • setStepSequenceNumber

        @Deprecated
void setStepSequenceNumber​(Long newStepSequenceNumber)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for StepSequenceNumber. (Deprecated Class, do not use. The sequence number of the Job if it is of type JobChainStep. Null if not a JobChainStep) This value is optional.

        Parameters:
        newStepSequenceNumber - the new value for StepSequenceNumber.
        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.

      • setCallId

        @Deprecated
void setCallId​(Long newCallId)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for CallId. (Deprecated Class, do not use. The Call ID for this Job if it is a JobChainCall. Null if not a JobChainCall) This value is optional.

        Parameters:
        newCallId - the new value for CallId.
        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.

      • setCallSequenceNumber

        @Deprecated
void setCallSequenceNumber​(Long newCallSequenceNumber)
        Deprecated.
        This class has been deprecated, use the Statistics class instead

        Set the value for CallSequenceNumber. (Deprecated Class, do not use. The sequence number of the Call if it is of type JobChainCall. Null if not a JobChainCall) This value is optional.

        Parameters:
        newCallSequenceNumber - the new value for CallSequenceNumber.
        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.

      • getSampleTimeZone

        TimeZone getSampleTimeZone()
        Get the SampleTimeZone.
        Returns:
        SampleTimeZone
        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.

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

      • setSampleTimeZone

        void setSampleTimeZone​(TimeZone newSampleTimeZone)
        Set the value for SampleTimeZone. This value is optional.
        Parameters:
        newSampleTimeZone - is the object to set SampleTimeZone to. The time zone of this statistics sample.

      • 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 StatisticsSample If this is null, then the object cannot be persisted.