com.day.cq.workflow.event

Class ExternalProcessPollingEvent

java.lang.Object

com.day.cq.workflow.event.ExternalProcessPollingEvent

All Implemented Interfaces:

java.io.Serializable

public class ExternalProcessPollingEvent
extends java.lang.Object
implements java.io.Serializable

A helper class to define and create external process polling events, identified using the topic EVENT_TOPIC

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TOPIC The job topic for adding an entry to the audit log.
static java.lang.String	PROPERTY_POLLING_ADVANCE_ON_TIMEOUT
static java.lang.String	PROPERTY_POLLING_EVENT
static java.lang.String	PROPERTY_POLLING_PROCESS_ID
static java.lang.String	PROPERTY_POLLING_START
static java.lang.String	PROPERTY_POLLING_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ExternalProcessPollingEvent(java.util.Map<java.lang.String,java.io.Serializable> workItemMap, java.io.Serializable externalProcessId) Creates a new WorkflowJob.

Method Summary

Modifier and Type	Method and Description
Event	createPollingCancelEvent() Convenience method to create a cancel timed event.
Event	createPollingEvent(long period, long timeoutSeconds, boolean advanceOnTimeout) Convenience method to create a timed event.
java.util.Map<java.lang.String,java.io.Serializable>	getWorkItemMap()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_TOPIC

public static final java.lang.String EVENT_TOPIC

The job topic for adding an entry to the audit log.

See Also:

Constant Field Values

PROPERTY_POLLING_TIMEOUT

public static final java.lang.String PROPERTY_POLLING_TIMEOUT

See Also:

Constant Field Values

PROPERTY_POLLING_ADVANCE_ON_TIMEOUT

public static final java.lang.String PROPERTY_POLLING_ADVANCE_ON_TIMEOUT

See Also:

Constant Field Values

PROPERTY_POLLING_START

public static final java.lang.String PROPERTY_POLLING_START

See Also:

Constant Field Values

PROPERTY_POLLING_EVENT

public static final java.lang.String PROPERTY_POLLING_EVENT

See Also:

Constant Field Values

PROPERTY_POLLING_PROCESS_ID

public static final java.lang.String PROPERTY_POLLING_PROCESS_ID

See Also:

Constant Field Values

Constructor Detail

ExternalProcessPollingEvent

public ExternalProcessPollingEvent(java.util.Map<java.lang.String,java.io.Serializable> workItemMap,
                                   java.io.Serializable externalProcessId)

Creates a new WorkflowJob.

Parameters:

workItemMap - Map item of WorkItem map to be used

externalProcessId - External process id to be used

Method Detail

getWorkItemMap

public java.util.Map<java.lang.String,java.io.Serializable> getWorkItemMap()

createPollingEvent

public Event createPollingEvent(long period,
                                long timeoutSeconds,
                                boolean advanceOnTimeout)

Convenience method to create a timed event.

Parameters:

period - period of time in seconds

timeoutSeconds - timeout parameter in seconds

advanceOnTimeout - true or false if it should advance on timeout

Returns:

Event Returns polling Event

createPollingCancelEvent

public Event createPollingCancelEvent()

Convenience method to create a cancel timed event.

Returns:

Event Returns polling cancel Event