org.jbpm.command
Class GetProcessInstanceCommand

java.lang.Object
  extended by org.jbpm.command.AbstractGetObjectBaseCommand
      extended by org.jbpm.command.GetProcessInstanceCommand
All Implemented Interfaces:
java.io.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
 java.lang.Object execute(JbpmContext jbpmContext)
           
 long getProcessInstanceId()
           
 long getTaskInstanceId()
           
 long getTokenId()
           
 void setProcessInstanceId(long processInstanceId)
           
 void setTaskInstanceId(long taskInstanceId)
           
 void setTokenId(long tokenId)
           
 
Methods inherited from class org.jbpm.command.AbstractGetObjectBaseCommand
getJbpmContext, getVariablesToInclude, isIncludeAllVariables, retrieveNode, retrieveProcessDefinition, retrieveProcessInstance, retrieveTaskInstanceDetails, retrieveToken, retrieveVariables, retrieveVariables, setIncludeAllVariables, setJbpmContext, setVariablesToInclude, setVariablesToInclude
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 java.lang.Object execute(JbpmContext jbpmContext)
                         throws java.lang.Exception
Throws:
java.lang.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)