WorkflowJob (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- com.day.cq.workflow.job.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

- Field Detail
  - JOB_TOPIC
```
public static final java.lang.String JOB_TOPIC
```
    The job topic for adding an entry to the audit log.
    
    See Also:
    
    Constant Field Values
  - JOB_TOPIC_WC
```
public static final java.lang.String JOB_TOPIC_WC
```
    See Also:
    
    Constant Field Values
  - WORKFLOW_JOB
```
public static final java.lang.String WORKFLOW_JOB
```
    The event property holding the WorkflowJob.
    
    See Also:
    
    Constant Field Values
  - WORKFLOW_JOB_ID
```
public static final java.lang.String WORKFLOW_JOB_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkflowJob
```
public WorkflowJob(java.util.Map item)
```
    Creates a new WorkflowJob.
    
    Parameters:
    
    item - creates the WorkflowJob instance using Map
- Method Detail
  - getWorkItemMap
```
public java.util.Map getWorkItemMap()
```
    Returns the WorkItem Mapof the job
    
    Returns:
    
    Map Map returns the workflow item map
  - 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 - integer. number of retries
    
    numOfParallelProcs - not currently used
    
    jobId - the job id to use
    
    Returns:
    
    Event Event the job event created