DelegateInvocation (Camunda Platform Javadocs 7.17.0-SNAPSHOT)

java.lang.Object
- org.camunda.bpm.engine.impl.delegate.DelegateInvocation

Direct Known Subclasses:

ActivityBehaviorInvocation, ActivityBehaviorSignalInvocation, CaseExecutionListenerInvocation, CaseVariableListenerInvocation, CreateStartFormInvocation, CreateTaskFormInvocation, DecisionInvocation, ExecutionListenerInvocation, ExpressionGetInvocation, ExpressionSetInvocation, FormFieldValidatorInvocation, JavaDelegateInvocation, ScriptInvocation, SubmitFormVariablesInvocation, TaskListenerInvocation
```
public abstract class DelegateInvocation
extends Object
```
Provides context about the invocation of usercode and handles the actual invocation

Author:

Daniel Meyer

See Also:

DelegateInterceptor

Field Summary

Fields
Modifier and Type Field Description

protected BaseDelegateExecution contextExecution

protected ResourceDefinitionEntity contextResource

protected Object invocationResult

Constructor Summary

Constructors
Constructor	Description
`DelegateInvocation(BaseDelegateExecution contextExecution, ResourceDefinitionEntity contextResource)`	Provide a context execution or resource definition in which context the invocation should be performed.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`BaseDelegateExecution`	`getContextExecution()`	returns the execution in which context this delegate is invoked.
`ResourceDefinitionEntity`	`getContextResource()`
`Object`	`getInvocationResult()`
`protected abstract void`	`invoke()`
`void`	`proceed()`	make the invocation proceed, performing the actual invocation of the user code.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - invocationResult
```
protected Object invocationResult
```
  - contextExecution
```
protected BaseDelegateExecution contextExecution
```
  - contextResource
```
protected ResourceDefinitionEntity contextResource
```
- Constructor Detail
  - DelegateInvocation
```
public DelegateInvocation(BaseDelegateExecution contextExecution,
                          ResourceDefinitionEntity contextResource)
```
    Provide a context execution or resource definition in which context the invocation should be performed. If both parameters are null, the invocation is performed in the current context.
    
    Parameters:
    
    contextExecution - set to an execution
- Method Detail
  - proceed
```
public void proceed()
             throws Exception
```
    make the invocation proceed, performing the actual invocation of the user code.
    
    Throws:
    
    Exception - the exception thrown by the user code
  - invoke
```
protected abstract void invoke()
                        throws Exception
```
    Throws:
    
    Exception
  - getInvocationResult
```
public Object getInvocationResult()
```
    Returns:
    
    the result of the invocation (can be null if the invocation does not return a result)
  - getContextExecution
```
public BaseDelegateExecution getContextExecution()
```
    returns the execution in which context this delegate is invoked. may be null
  - getContextResource
```
public ResourceDefinitionEntity getContextResource()
```