Interface JobChainCall

    • Method Detail

      • getAverageCallStartDelay

        Long getAverageCallStartDelay()
        Get the value for AverageCallStartDelay. (Statistic: The average delay after which jobs for this call start once the parent step starts.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        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. (Statistic: The average run-time for the jobs of this JobChainCall in milliseconds. If no value is available for the call, the function will NOT fallback to the jobDefinition value.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getCallStartCount

        Long getCallStartCount()
        Get the value for CallStartCount. (Statistic: the number of times this call has started executing.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getDescription

        String getDescription()
        Get the value for Description. (Optional description)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getExecutionCompletedCount

        Long getExecutionCompletedCount()
        Get the value for ExecutionCompletedCount. (Statistic: the number of times this call has executed successfully.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getSequenceNumber

        Long getSequenceNumber()
        Get the value for SequenceNumber. (The call sequence number.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getStandardDeviationCallStartDelay

        BigDecimal getStandardDeviationCallStartDelay()
        Get the value for StandardDeviationCallStartDelay. (Statistic: The standard deviation of the delay starting jobs of this JobChainCall.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getStandardDeviationRunTime

        BigDecimal getStandardDeviationRunTime()
        Get the value for StandardDeviationRunTime. (Statistic: The standard deviation of the run-time for the jobs of this JobChainCall.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isIgnoreStatus

        boolean isIgnoreStatus()
        Get the value for IgnoreStatus. (Ignore the status of this job for the purposes of calculating the final status of the step)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isStepWaitingOnJob

        boolean isStepWaitingOnJob()
        Get the value for StepWaitingOnJob. (Should the step wait for the job to complete before it can complete? If set to false, the step will not wait for the job to finish, it will also automatically ignore the status of the job.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setSequenceNumber

        void setSequenceNumber​(Long newSequenceNumber)
        Set the value for SequenceNumber. (The call sequence number.) This value is mandatory.
        Parameters:
        newSequenceNumber - the new value for SequenceNumber. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setIgnoreStatus

        void setIgnoreStatus​(boolean newIgnoreStatus)
        Set the value for IgnoreStatus. (Ignore the status of this job for the purposes of calculating the final status of the step)
        Parameters:
        newIgnoreStatus - the new value for IgnoreStatus.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setStepWaitingOnJob

        void setStepWaitingOnJob​(boolean newStepWaitingOnJob)
        Set the value for StepWaitingOnJob. (Should the step wait for the job to complete before it can complete? If set to false, the step will not wait for the job to finish, it will also automatically ignore the status of the job.)
        Parameters:
        newStepWaitingOnJob - the new value for StepWaitingOnJob.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • createConstraintContext

        ConstraintContext createConstraintContext()
        Create a ConstraintContext so that the constraints can be verified.
        Returns:
        The ConstraintContext
      • getStatisticsByKeyParameters

        Statistics getStatisticsByKeyParameters​(Map<String,​String> keyParameters)
        Get a statistics object associated to this JobChainCall.
        Parameters:
        keyParameters - KeyParameters as a map of String names -> String values
        Returns:
        Statistics
      • resetStatistics

        void resetStatistics()
        Reset the counters and statistics for this job-chain call.
      • enableAtSubmit

        void enableAtSubmit()
        Enables the job at Submit Time by setting the SubmitDisabled to false.
      • disableAtSubmit

        void disableAtSubmit()
        Disables the job at Submit Time by setting the SubmitDisabled to true.
      • setJobDefinition

        void setJobDefinition​(JobDefinition newJobDefinition)
        Set the value for JobDefinition. This value is mandatory.
        Parameters:
        newJobDefinition - is the object to set JobDefinition to. A call to a job definition from a job chain. If this is null, then the object cannot be persisted.
      • getJobChainCallInExpressionParameterByLocalJobDefinitionParameter

        JobChainCallInExpressionParameter getJobChainCallInExpressionParameterByLocalJobDefinitionParameter​(JobDefinitionParameter localJobDefinitionParameter)
        Get the JobChainCallInExpressionParameter by DestinationJobDefinitionParameter.
        Parameters:
        localJobDefinitionParameter -
        Returns:
        the JobChainCallInExpressionParameter, or null if it could not be found
      • getJobChainCallInReferenceParameterByLocalJobDefinitionParameter

        JobChainCallInReferenceParameter getJobChainCallInReferenceParameterByLocalJobDefinitionParameter​(JobDefinitionParameter localJobDefinitionParameter)
        Get the JobChainCallInReferenceParameter by DestinationJobDefinitionParameter.
        Parameters:
        localJobDefinitionParameter -
        Returns:
        the JobChainCallInReferenceParameter, or null if it could not be found
      • getJobChainCallPrecondition

        JobChainCallPrecondition getJobChainCallPrecondition()
        Get the JobChainCallPrecondition. The precondition for a job chain call.
        Returns:
        nullJobChainCallPrecondition
        Throws:
        ObjectDeletedException - If this method is called when the object has been marked for deletion.
        ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getJobChainCallSchedulingParameterByName

        JobChainCallSchedulingParameter getJobChainCallSchedulingParameterByName​(SchedulingParameterName name)
        Get the JobChainCallSchedulingParameter by NameJobChainCall.
        Parameters:
        name -
        Returns:
        the JobChainCallSchedulingParameter, or null if it could not be found
      • getJobChainCallJobLockByJobLock

        JobChainCallJobLock getJobChainCallJobLockByJobLock​(JobLock jobLock)
        Get the JobChainCallJobLock by JobChainCallJobLock.
        Parameters:
        jobLock -
        Returns:
        the JobChainCallJobLock, or null if it could not be found