com.day.cq.workflow.job
Class TimeoutJob

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

protected WorkItem	item The WorkItem of the job.
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

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

Method Summary

org.osgi.service.event.Event	cancelEvent(boolean executeParallel)
org.osgi.service.event.Event	createEvent(boolean executeParallel, long seconds) Convenience method to create a job event for the workflow job.
String	getHandler() Returns the timeout handler
WorkItem	getWorkItem() Returns the WorkItem of the job

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

item

protected WorkItem item

The WorkItem of the job.

Constructor Detail

TimeoutJob

public TimeoutJob(WorkItem item,
                  String handler)

Creates a new WorkflowJob.

Method Detail

getWorkItem

public WorkItem getWorkItem()

Returns the WorkItem of the job

getHandler

public String getHandler()

Returns the timeout handler

createEvent

public org.osgi.service.event.Event createEvent(boolean executeParallel,
                                                long seconds)

Convenience method to create a job event for the workflow job.

cancelEvent

public org.osgi.service.event.Event cancelEvent(boolean executeParallel)