TimeoutJob (The Adobe Experience Manager SDK 2021.8.5705.20210810T082946Z-210700)

java.lang.Object
- com.adobe.granite.workflow.job.TimeoutJob

All Implemented Interfaces:

Serializable
```
public class TimeoutJob
extends Object
implements Serializable
```
The TimeoutJob 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 String`	`TIMEOUT_JOB`	The event property holding the `TimeoutJob`.
`static String`	`TIMEOUT_JOB_TOPIC`	The job topic for adding an entry to the audit log.

Constructor Summary

Constructors
Constructor Description

TimeoutJob(WorkItem item, String handler)
Creates a new WorkflowJob.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Event`	`cancelEvent(boolean executeParallel)`
`Event`	`createEvent(boolean executeParallel, long seconds, boolean addOffset)`	Convenience method to create a job event for the workflow job.
`String`	`getHandler()`	Returns the timeout handler
`String`	`getWorkItemId()`	Returns the `WorkItem` `Id` of the job

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TIMEOUT_JOB_TOPIC
```
public static final String TIMEOUT_JOB_TOPIC
```
    The job topic for adding an entry to the audit log.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_JOB
```
public static final String TIMEOUT_JOB
```
    The event property holding the TimeoutJob.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TimeoutJob
```
public TimeoutJob(WorkItem item,
                  String handler)
```
    Creates a new WorkflowJob.
    
    Parameters:
    
    item - the work item
    
    handler - the timeout job handler
- Method Detail
  - getWorkItemId
```
public String getWorkItemId()
```
    Returns the WorkItem Id of the job
    
    Returns:
    
    the WorkItem Id of the job
  - getHandler
```
public String getHandler()
```
    Returns the timeout handler
    
    Returns:
    
    the timeout handler
  - createEvent
```
public Event createEvent(boolean executeParallel,
                         long seconds,
                         boolean addOffset)
```
    Convenience method to create a job event for the workflow job.
    
    Parameters:
    
    executeParallel - whether to execute in parallel or not
    
    seconds - number of seconds
    
    addOffset - whether to add the current time to the specified number of seconds
    
    Returns:
    
    the created event
  - cancelEvent
```
public Event cancelEvent(boolean executeParallel)
```