org.jbpm.command
Class GetProcessInstancesCommand

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

All Implemented Interfaces:

java.io.Serializable, Command

public class GetProcessInstancesCommand
extends AbstractGetObjectBaseCommand

This command can retrieve all process instances (e.g. for admin client). You have the possibility to filter the command, therefor use the available attributes

Author:

Bernd Ruecker (bernd.ruecker@camunda.com)

See Also:

Serialized Form

Constructor Summary

GetProcessInstancesCommand()

Method Summary

java.lang.Object	execute(JbpmContext jbpmContext)
GetProcessInstancesCommand	fromStartDate(java.util.Date fromStartDate)
java.lang.String	getAdditionalToStringInformation()
java.util.Date	getFromStartDate()
java.lang.String	getProcessDefinitionName()
long	getProcessId() Deprecated.
long	getProcessInstanceId()
java.lang.String	getProcessName() Deprecated.
java.lang.String	getStateName()
java.util.Date	getUntilStartDate()
java.lang.String	getVersion()
boolean	isOnlyRunning()
GetProcessInstancesCommand	onlyRunning(boolean onlyRunning)
GetProcessInstancesCommand	processDefinitionName(java.lang.String processName)
GetProcessInstancesCommand	processInstanceId(long processId)
java.util.List	retrieveProcessInstanceDetails(java.util.List processInstanceList) access everything on all processInstance objects, which is not in the default fetch group from hibernate, but needs to be accesible from the client overwrite this, if you need more details in your client
void	setFromStartDate(java.util.Date fromStartDate)
void	setOnlyRunning(boolean onlyRunning)
void	setProcessDefinitionName(java.lang.String processName)
void	setProcessId(long processId) Deprecated.
void	setProcessInstanceId(long processId)
void	setProcessName(java.lang.String processName) Deprecated.
void	setStateName(java.lang.String stateName)
void	setUntilStartDate(java.util.Date untilStartDate)
void	setVersion(java.lang.String version)
GetProcessInstancesCommand	stateName(java.lang.String stateName)
GetProcessInstancesCommand	untilStartDate(java.util.Date untilStartDate)
GetProcessInstancesCommand	version(java.lang.String version)

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

GetProcessInstancesCommand

public GetProcessInstancesCommand()

Method Detail

execute

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

Throws:

java.lang.Exception

retrieveProcessInstanceDetails

public java.util.List retrieveProcessInstanceDetails(java.util.List processInstanceList)

access everything on all processInstance objects, which is not in the default fetch group from hibernate, but needs to be accesible from the client overwrite this, if you need more details in your client

getFromStartDate

public java.util.Date getFromStartDate()

setFromStartDate

public void setFromStartDate(java.util.Date fromStartDate)

isOnlyRunning

public boolean isOnlyRunning()

setOnlyRunning

public void setOnlyRunning(boolean onlyRunning)

getProcessName

public java.lang.String getProcessName()

Deprecated.

setProcessName

public void setProcessName(java.lang.String processName)

Deprecated.

getProcessDefinitionName

public java.lang.String getProcessDefinitionName()

setProcessDefinitionName

public void setProcessDefinitionName(java.lang.String processName)

getStateName

public java.lang.String getStateName()

setStateName

public void setStateName(java.lang.String stateName)

getUntilStartDate

public java.util.Date getUntilStartDate()

setUntilStartDate

public void setUntilStartDate(java.util.Date untilStartDate)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getProcessInstanceId

public long getProcessInstanceId()

setProcessInstanceId

public void setProcessInstanceId(long processId)

getProcessId

public long getProcessId()

Deprecated.

setProcessId

public void setProcessId(long processId)

Deprecated.

getAdditionalToStringInformation

public java.lang.String getAdditionalToStringInformation()

Overrides:

getAdditionalToStringInformation in class AbstractBaseCommand

fromStartDate

public GetProcessInstancesCommand fromStartDate(java.util.Date fromStartDate)

onlyRunning

public GetProcessInstancesCommand onlyRunning(boolean onlyRunning)

processDefinitionName

public GetProcessInstancesCommand processDefinitionName(java.lang.String processName)

stateName

public GetProcessInstancesCommand stateName(java.lang.String stateName)

untilStartDate

public GetProcessInstancesCommand untilStartDate(java.util.Date untilStartDate)

version

public GetProcessInstancesCommand version(java.lang.String version)

processInstanceId

public GetProcessInstancesCommand processInstanceId(long processId)