Package 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 Details

    • HippoWorkflowEvent

      public HippoWorkflowEvent()

    • HippoWorkflowEvent

      public HippoWorkflowEvent(HippoEvent event)

  • Method Details

    • 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)