Package org.camunda.bpm.engine.impl.cmd

Class HandleExternalTaskBpmnErrorCmd

java.lang.Object

org.camunda.bpm.engine.impl.cmd.ExternalTaskCmd

org.camunda.bpm.engine.impl.cmd.HandleExternalTaskCmd

org.camunda.bpm.engine.impl.cmd.HandleExternalTaskBpmnErrorCmd

All Implemented Interfaces:

Command<java.lang.Void>

public class HandleExternalTaskBpmnErrorCmd
extends HandleExternalTaskCmd

Command to handle an external task BPMN error.

Author:

Christopher Zell

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	errorCode	The error code of the corresponding bpmn error.
protected java.lang.String	errorMessage
protected java.util.Map<java.lang.String,java.lang.Object>	variables

Fields inherited from class org.camunda.bpm.engine.impl.cmd.HandleExternalTaskCmd

workerId

Fields inherited from class org.camunda.bpm.engine.impl.cmd.ExternalTaskCmd

externalTaskId

Constructor Summary

Constructors

Constructor	Description
HandleExternalTaskBpmnErrorCmd(java.lang.String externalTaskId, java.lang.String workerId, java.lang.String errorCode)
HandleExternalTaskBpmnErrorCmd(java.lang.String externalTaskId, java.lang.String workerId, java.lang.String errorCode, java.lang.String errorMessage, java.util.Map<java.lang.String,java.lang.Object> variables)

Method Summary

Modifier and Type	Method	Description
void	execute(ExternalTaskEntity externalTask)	Executes the specific external task commands, which belongs to the current sub class.
java.lang.String	getErrorMessageOnWrongWorkerAccess()	Returns the error message.
protected void	validateInput()	Validates the current input of the command.

Methods inherited from class org.camunda.bpm.engine.impl.cmd.HandleExternalTaskCmd

execute, validateWorkerViolation

Methods inherited from class org.camunda.bpm.engine.impl.cmd.ExternalTaskCmd

getUserOperationLogOperationType, getUserOperationLogPropertyChanges, writeUserOperationLog

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

isRetryable

Field Detail

errorCode

protected java.lang.String errorCode

The error code of the corresponding bpmn error.

errorMessage

protected java.lang.String errorMessage

variables

protected java.util.Map<java.lang.String,java.lang.Object> variables

Constructor Detail

HandleExternalTaskBpmnErrorCmd

public HandleExternalTaskBpmnErrorCmd(java.lang.String externalTaskId,
                                      java.lang.String workerId,
                                      java.lang.String errorCode)

HandleExternalTaskBpmnErrorCmd

public HandleExternalTaskBpmnErrorCmd(java.lang.String externalTaskId,
                                      java.lang.String workerId,
                                      java.lang.String errorCode,
                                      java.lang.String errorMessage,
                                      java.util.Map<java.lang.String,java.lang.Object> variables)

Method Detail

validateInput

protected void validateInput()

Description copied from class: HandleExternalTaskCmd

Validates the current input of the command.

Overrides:

validateInput in class HandleExternalTaskCmd

getErrorMessageOnWrongWorkerAccess

public java.lang.String getErrorMessageOnWrongWorkerAccess()

Description copied from class: HandleExternalTaskCmd

Returns the error message. Which is used to create an specific message for the BadUserRequestException if an worker has no rights to execute commands of the external task.

Specified by:

getErrorMessageOnWrongWorkerAccess in class HandleExternalTaskCmd

Returns:

the specific error message

execute

public void execute(ExternalTaskEntity externalTask)

Description copied from class: ExternalTaskCmd

Executes the specific external task commands, which belongs to the current sub class.

Specified by:

execute in class ExternalTaskCmd

Parameters:

externalTask - the external task which is used for the command execution