org.jbpm.command
Class GetProcessInstanceCommand

java.lang.Object
  org.jbpm.command.AbstractBaseCommand
      org.jbpm.command.AbstractGetObjectBaseCommand
          org.jbpm.command.GetProcessInstanceCommand

All Implemented Interfaces:

Serializable, Command

public class GetProcessInstanceCommand
extends AbstractGetObjectBaseCommand

This command can retrieve the matching process instances (e.g. for admin client) with the given process-id, token id or task-id

Author:

Bernd Ruecker (bernd.ruecker@camunda.com)

See Also:

Serialized Form

Constructor Summary

GetProcessInstanceCommand()

GetProcessInstanceCommand(long processInstanceId)

GetProcessInstanceCommand(long processInstanceId, boolean includeVariables, boolean includeLogs)

Method Summary

Object	execute(JbpmContext jbpmContext)
String	getAdditionalToStringInformation()
long	getProcessInstanceId()
long	getTaskInstanceId()
long	getTokenId()
GetProcessInstanceCommand	processInstanceId(long processInstanceId)
void	setProcessInstanceId(long processInstanceId)
void	setTaskInstanceId(long taskInstanceId)
void	setTokenId(long tokenId)
GetProcessInstanceCommand	taskInstanceId(long taskInstanceId)
GetProcessInstanceCommand	tokenId(long tokenId)

Methods inherited from class org.jbpm.command.AbstractGetObjectBaseCommand

getJbpmContext, getVariablesToInclude, includeAllVariables, isIncludeAllVariables, retrieveNode, retrieveProcessDefinition, retrieveProcessInstance, retrieveTaskInstanceDetails, retrieveToken, retrieveVariables, retrieveVariables, setIncludeAllVariables, setJbpmContext, setVariablesToInclude, setVariablesToInclude, variablesToInclude, variablesToInclude

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

GetProcessInstanceCommand

public GetProcessInstanceCommand()

GetProcessInstanceCommand

public GetProcessInstanceCommand(long processInstanceId)

GetProcessInstanceCommand

public GetProcessInstanceCommand(long processInstanceId,
                                 boolean includeVariables,
                                 boolean includeLogs)

Method Detail

execute

public Object execute(JbpmContext jbpmContext)
               throws Exception

Throws:

Exception

getProcessInstanceId

public long getProcessInstanceId()

setProcessInstanceId

public void setProcessInstanceId(long processInstanceId)

getTaskInstanceId

public long getTaskInstanceId()

setTaskInstanceId

public void setTaskInstanceId(long taskInstanceId)

getTokenId

public long getTokenId()

setTokenId

public void setTokenId(long tokenId)

getAdditionalToStringInformation

public String getAdditionalToStringInformation()

Overrides:

getAdditionalToStringInformation in class AbstractBaseCommand

processInstanceId

public GetProcessInstanceCommand processInstanceId(long processInstanceId)

taskInstanceId

public GetProcessInstanceCommand taskInstanceId(long taskInstanceId)

tokenId

public GetProcessInstanceCommand tokenId(long tokenId)