org.jbpm.command
Class AbstractProcessInstanceBaseCommand

java.lang.Object
  org.jbpm.command.AbstractBaseCommand
      org.jbpm.command.AbstractProcessInstanceBaseCommand

All Implemented Interfaces:

Serializable, Command

Direct Known Subclasses:

ChangeProcessInstanceVersionCommand, ResumeProcessInstanceCommand, SuspendProcessInstanceCommand

public abstract class AbstractProcessInstanceBaseCommand
extends AbstractBaseCommand

Abstract base class for all commands working on ProcessInstances. The ProcessInstance can either be specified by id or multiple ids. The alternative is to specify a ProcessDefinition name and version. In this case all found ProcessInstances are processed. If no version is specified, all versions are taken into account. if onlyRunning is set to false (default is true) already ended ProcessInstances are processed too.

Author:

bernd.ruecker@camunda.com

See Also:

Serialized Form

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

AbstractProcessInstanceBaseCommand()

Method Summary

Object	execute(JbpmContext jbpmContext)
abstract ProcessInstance	execute(ProcessInstance processInstance)
protected JbpmContext	getJbpmContext()
long	getProcessInstanceId() return the process instance id in case only one process instance id is set.
long[]	getProcessInstanceIds()
String	getProcessName()
int	getProcessVersion()
boolean	isOnlyRunning()
AbstractProcessInstanceBaseCommand	onlyRunning(boolean onlyRunning)
AbstractProcessInstanceBaseCommand	processInstanceId(long processInstanceId)
AbstractProcessInstanceBaseCommand	processInstanceIds(long[] processInstanceIds)
AbstractProcessInstanceBaseCommand	processName(String processName)
AbstractProcessInstanceBaseCommand	processVersion(int processVersion)
void	setOnlyRunning(boolean onlyRunning)
void	setProcessInstanceId(long processInstanceId)
void	setProcessInstanceIds(long[] processInstanceIds)
void	setProcessName(String processName)
void	setProcessVersion(int processVersion)
String	toString() Overwrite toString to keep semantic of getAdditionalToStringInformation

Methods inherited from class org.jbpm.command.AbstractBaseCommand

getAdditionalToStringInformation

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

AbstractProcessInstanceBaseCommand

public AbstractProcessInstanceBaseCommand()

Method Detail

getJbpmContext

protected JbpmContext getJbpmContext()

execute

public Object execute(JbpmContext jbpmContext)
               throws Exception

Throws:

Exception

execute

public abstract ProcessInstance execute(ProcessInstance processInstance)

setProcessInstanceIds

public void setProcessInstanceIds(long[] processInstanceIds)

setProcessInstanceId

public void setProcessInstanceId(long processInstanceId)

toString

public String toString()

Overwrite toString to keep semantic of getAdditionalToStringInformation

Overrides:

toString in class AbstractBaseCommand

getProcessName

public String getProcessName()

setProcessName

public void setProcessName(String processName)

getProcessVersion

public int getProcessVersion()

setProcessVersion

public void setProcessVersion(int processVersion)

getProcessInstanceIds

public long[] getProcessInstanceIds()

getProcessInstanceId

public long getProcessInstanceId()

return the process instance id in case only one process instance id is set. Otherwise an IllegalStateException is thrown

isOnlyRunning

public boolean isOnlyRunning()

setOnlyRunning

public void setOnlyRunning(boolean onlyRunning)

processInstanceIds

public AbstractProcessInstanceBaseCommand processInstanceIds(long[] processInstanceIds)

processInstanceId

public AbstractProcessInstanceBaseCommand processInstanceId(long processInstanceId)

processName

public AbstractProcessInstanceBaseCommand processName(String processName)

processVersion

public AbstractProcessInstanceBaseCommand processVersion(int processVersion)

onlyRunning

public AbstractProcessInstanceBaseCommand onlyRunning(boolean onlyRunning)