org.onehippo.repository.events

Class HippoWorkflowEvent<T extends HippoWorkflowEvent<T>>

java.lang.Object

org.onehippo.cms7.event.HippoEvent<T>

org.onehippo.repository.events.HippoWorkflowEvent<T>

All Implemented Interfaces:

Cloneable

public class HippoWorkflowEvent<T extends HippoWorkflowEvent<T>>
extends HippoEvent<T>

Constructor Summary

Constructors

Constructor and Description
HippoWorkflowEvent()
HippoWorkflowEvent(HippoEvent event)

Method Summary

Modifier and Type	Method and Description
List<String>	arguments() The arguments passed to the workflow invocation
T	arguments(List<String> arguments)
String	className() The name of the workflow class
T	className(String className)
String	documentPath() Deprecated. use subjectPath() instead
T	documentPath(String documentPath) Deprecated. use subjectId(String) instead
String	documentType() The type of document the workflow was called on, if any
T	documentType(String documentType)
Throwable	exception() The exception if any occurred during the invocation of the workflow
T	exception(Throwable e)
String	handleUuid() Deprecated. use subjectId() instead
T	handleUuid(String handleUuid) Deprecated. use subjectId(String) instead
String	interaction() The value of the interaction property is a combination of the category, name, and action of the root invocation of the invocation hierarchy.
T	interaction(String interaction)
String	interactionId() A workflow invocation can result in nested workflow invocations if the workflow action in turn invokes another workflow.
T	interactionId(String interactionId)
String	methodName() Deprecated. use HippoEvent.action() instead
T	methodName(String methodName) Deprecated. use HippoEvent.action(String) instead
String	returnType() The java type of the object returned by the workflow action, if any
T	returnType(String returnType)
String	returnValue() The value returned by the workflow action, if any
T	returnValue(String returnValue)
String	subjectId() The JCR node identifier of the workflow subject
T	subjectId(String subjectId)
String	subjectPath() The JCR node path of the workflow subject
T	subjectPath(String subjectPath)
Boolean	success() Whether the workflow invocation was successful
String	workflowCategory() The workflow category
T	workflowCategory(String category)
String	workflowName() The workflow name
T	workflowName(String workflowName)

Methods inherited from class org.onehippo.cms7.event.HippoEvent

action, action, application, application, category, category, clone, get, getValues, isSealed, message, message, put, result, result, sealEvent, set, system, system, timestamp, timestamp, user, user

Methods inherited from class java.lang.Object

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

Constructor Detail

HippoWorkflowEvent

public HippoWorkflowEvent()

HippoWorkflowEvent

public HippoWorkflowEvent(HippoEvent event)

Method Detail

className

public String className()

The name of the workflow class

className

public T className(String className)

methodName

@Deprecated
public String methodName()

Deprecated. use HippoEvent.action() instead

methodName

@Deprecated
public T methodName(String methodName)

Deprecated. use HippoEvent.action(String) instead

subjectId

public String subjectId()

The JCR node identifier of the workflow subject

subjectId

public T subjectId(String subjectId)

handleUuid

@Deprecated
public String handleUuid()

Deprecated. use subjectId() instead

handleUuid

@Deprecated
public T handleUuid(String handleUuid)

Deprecated. use subjectId(String) instead

returnType

public String returnType()

The java type of the object returned by the workflow action, if any

returnType

public T returnType(String returnType)

returnValue

public String returnValue()

The value returned by the workflow action, if any

returnValue

public T returnValue(String returnValue)

subjectPath

public String subjectPath()

The JCR node path of the workflow subject

subjectPath

public T subjectPath(String subjectPath)

documentPath

@Deprecated
public String documentPath()

Deprecated. use subjectPath() instead

documentPath

@Deprecated
public T documentPath(String documentPath)

Deprecated. use subjectId(String) instead

arguments

public List<String> arguments()

The arguments passed to the workflow invocation

arguments

public T arguments(List<String> arguments)

interactionId

public String interactionId()

A workflow invocation can result in nested workflow invocations if the workflow action in turn invokes another workflow. In this case these workflow actions have the same interaction id in order to identify them as part of the same user-level workflow action.

interaction

public String interaction()

The value of the interaction property is a combination of the category, name, and action of the root invocation of the invocation hierarchy.

interactionId

public T interactionId(String interactionId)

interaction

public T interaction(String interaction)

workflowCategory

public String workflowCategory()

The workflow category

workflowCategory

public T workflowCategory(String category)

workflowName

public String workflowName()

The workflow name

workflowName

public T workflowName(String workflowName)

exception

public Throwable exception()

The exception if any occurred during the invocation of the workflow

exception

public T exception(Throwable e)

success

public Boolean success()

Whether the workflow invocation was successful

documentType

public String documentType()

The type of document the workflow was called on, if any

documentType

public T documentType(String documentType)