Package com.day.cq.workflow.event
Class ExternalProcessPollingEvent
- java.lang.Object
-
- com.day.cq.workflow.event.ExternalProcessPollingEvent
-
- All Implemented Interfaces:
Serializable
public class ExternalProcessPollingEvent extends Object implements Serializable
A helper class to define and create external process polling events, identified using the topicEVENT_TOPIC
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
EVENT_TOPIC
The job topic for adding an entry to the audit log.static String
PROPERTY_POLLING_ADVANCE_ON_TIMEOUT
static String
PROPERTY_POLLING_EVENT
static String
PROPERTY_POLLING_PROCESS_ID
static String
PROPERTY_POLLING_START
static String
PROPERTY_POLLING_TIMEOUT
-
Constructor Summary
Constructors Constructor Description ExternalProcessPollingEvent(Map<String,Serializable> workItemMap, Serializable externalProcessId)
Creates a new WorkflowJob.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.Map<String,Serializable>
getWorkItemMap()
-
-
-
Field Detail
-
EVENT_TOPIC
public static final 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 String PROPERTY_POLLING_TIMEOUT
- See Also:
- Constant Field Values
-
PROPERTY_POLLING_ADVANCE_ON_TIMEOUT
public static final String PROPERTY_POLLING_ADVANCE_ON_TIMEOUT
- See Also:
- Constant Field Values
-
PROPERTY_POLLING_START
public static final String PROPERTY_POLLING_START
- See Also:
- Constant Field Values
-
PROPERTY_POLLING_EVENT
public static final String PROPERTY_POLLING_EVENT
- See Also:
- Constant Field Values
-
PROPERTY_POLLING_PROCESS_ID
public static final String PROPERTY_POLLING_PROCESS_ID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ExternalProcessPollingEvent
public ExternalProcessPollingEvent(Map<String,Serializable> workItemMap, Serializable externalProcessId)
Creates a new WorkflowJob.- Parameters:
workItemMap
-Map
item of WorkItem map to be usedexternalProcessId
- External process id to be used
-
-
Method Detail
-
getWorkItemMap
public Map<String,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 secondstimeoutSeconds
- timeout parameter in secondsadvanceOnTimeout
- true or false if it should advance on timeout- Returns:
- Event Returns polling
Event
-
-