Interface CronJobNotificationTemplateContext

  • All Known Implementing Classes:
    DefaultCronJobNotificationTemplateContext

    public interface CronJobNotificationTemplateContext
    Simple interface used by Velocity script to render mail as result of finished job and its significant properties.
    Since:
    3.1-u7
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCronJobName()
      Gets the name of the executed CronJob.
      java.lang.String getDuration()
      Gets the duration of the executed CronJob.
      java.lang.String getEndDate()
      Gets the end date of executed CronJob.
      java.lang.String getResult()
      Gets the resulting state of executed CronJob.
      java.lang.String getStartDate()
      Gets the start date of executed CronJob.
      java.lang.String getStatus()
      Gets the final status of the CronJob.
    • Method Detail

      • getCronJobName

        java.lang.String getCronJobName()
        Gets the name of the executed CronJob.
        Returns:
        name of CronJob
      • getStartDate

        java.lang.String getStartDate()
        Gets the start date of executed CronJob.
        Returns:
        start date
      • getEndDate

        java.lang.String getEndDate()
        Gets the end date of executed CronJob.
        Returns:
        end date
      • getDuration

        java.lang.String getDuration()
        Gets the duration of the executed CronJob.
        Returns:
        duration
      • getResult

        java.lang.String getResult()
        Gets the resulting state of executed CronJob. Will be one of ERROR, FAILURE, SUCCESS, UNKNOWN.
        Returns:
        result of CronJob
      • getStatus

        java.lang.String getStatus()
        Gets the final status of the CronJob. Should be one of ABORTED, FINISHED, UNKNOWN.
        Returns:
        final status of CronJob