org.jbpm.command
Class CancelProcessInstanceCommand

java.lang.Object
  org.jbpm.command.AbstractBaseCommand
      org.jbpm.command.AbstractCancelCommand
          org.jbpm.command.CancelProcessInstanceCommand

All Implemented Interfaces:

java.io.Serializable, Command

public class CancelProcessInstanceCommand
extends AbstractCancelCommand

Cancel the given ProcessInstance with all Tokens. Maybe running sub process instances are currently not canceled.

Author:

Bernd Ruecker (bernd.ruecker@camunda.com)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jbpm.command.AbstractCancelCommand

CANCELLATION_INDICATOR_VARIABLE_NAME, jbpmContext, log

Constructor Summary

CancelProcessInstanceCommand()

CancelProcessInstanceCommand(long processInstanceId)

Method Summary

protected void	cancelProcess(long processIdToCancel)
java.lang.Object	execute(JbpmContext jbpmContext)
java.lang.String	getAdditionalToStringInformation()
long	getProcessId() Deprecated. use getProcessInstanceId instead
long	getProcessInstanceId()
CancelProcessInstanceCommand	processInstanceId(long processInstanceId)
void	setProcessId(long processId) Deprecated. use setProcessInstanceId instead
void	setProcessInstanceId(long processInstanceId)

Methods inherited from class org.jbpm.command.AbstractCancelCommand

cancelTasks, cancelToken, cancelTokens, getTasksForToken

Methods inherited from class org.jbpm.command.AbstractBaseCommand

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelProcessInstanceCommand

public CancelProcessInstanceCommand()

CancelProcessInstanceCommand

public CancelProcessInstanceCommand(long processInstanceId)

Method Detail

execute

public java.lang.Object execute(JbpmContext jbpmContext)
                         throws java.lang.Exception

Throws:

java.lang.Exception

cancelProcess

protected void cancelProcess(long processIdToCancel)

getProcessInstanceId

public long getProcessInstanceId()

setProcessInstanceId

public void setProcessInstanceId(long processInstanceId)

getProcessId

public long getProcessId()

Deprecated. use getProcessInstanceId instead

setProcessId

public void setProcessId(long processId)

Deprecated. use setProcessInstanceId instead

getAdditionalToStringInformation

public java.lang.String getAdditionalToStringInformation()

Overrides:

getAdditionalToStringInformation in class AbstractBaseCommand

processInstanceId

public CancelProcessInstanceCommand processInstanceId(long processInstanceId)