Class WorkflowJob

  • All Implemented Interfaces:
    java.io.Serializable

    public class WorkflowJob
    extends java.lang.Object
    implements java.io.Serializable
    The WorkflowJob class provides a utility for creating event triggered job used for programmed/scripted workflow steps.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String JOB_TOPIC
      The job topic for adding an entry to the audit log.
      static java.lang.String JOB_TOPIC_WC  
      static java.lang.String WORKFLOW_JOB
      The event property holding the WorkflowJob.
      static java.lang.String WORKFLOW_JOB_ID  
    • Constructor Summary

      Constructors 
      Constructor Description
      WorkflowJob​(java.util.Map item)
      Creates a new WorkflowJob.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Event createJobEvent​(java.lang.Integer retryCount, int numOfParallelProcs, java.lang.String jobId)
      Convenience method to create a job event for the workflow job.
      java.util.Map getWorkItemMap()
      Returns the WorkItem Map of the job
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • WorkflowJob

        public WorkflowJob​(java.util.Map item)
        Creates a new WorkflowJob.
        Parameters:
        item - the work item
    • Method Detail

      • getWorkItemMap

        public java.util.Map getWorkItemMap()
        Returns the WorkItem Map of the job
        Returns:
        the WorkItem Map of the job
      • createJobEvent

        public Event createJobEvent​(java.lang.Integer retryCount,
                                    int numOfParallelProcs,
                                    java.lang.String jobId)
        Convenience method to create a job event for the workflow job.
        Parameters:
        retryCount - the retryCount
        numOfParallelProcs - the number of parallel processes
        jobId - the workflow job id
        Returns:
        the created job event