org.jbpm.command
Class AbstractTokenBaseCommand

java.lang.Object
  org.jbpm.command.AbstractTokenBaseCommand

All Implemented Interfaces:

java.io.Serializable, Command

Direct Known Subclasses:

BatchSignalCommand, ResumeTokenCommand, SuspendTokenCommand, UnlockTokenCommand

public abstract class AbstractTokenBaseCommand
extends java.lang.Object
implements Command

Abstract base class for commands working on Tokens. The Token can either be specified by id or multiple ids. The alternative is to specify a ProcessDefinition name, a required node name and version. In this case all found Tokens are processed. If no version is specified, all versions are taken into account. Attention: The result of the command is either a List of Tokens or one single Token, depending if this command operates on one single instance (indicated by "operateOnSingleObject").

Author:

bernd.ruecker@camunda.com

See Also:

Serialized Form

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

AbstractTokenBaseCommand()

Method Summary

java.lang.Object	execute(JbpmContext jbpmContext)
abstract java.lang.Object	execute(Token token)
java.lang.String	getAdditionalToStringInformation()
protected JbpmContext	getJbpmContext()
java.lang.String	getProcessName()
int	getProcessVersion()
java.lang.String	getStateName()
long	getTokenId() return the process instance id in case only one process instance id is set.
long[]	getTokenIds()
boolean	isOperateOnSingleObject()
AbstractTokenBaseCommand	processName(java.lang.String processName)
AbstractTokenBaseCommand	processVersion(int processVersion)
void	setProcessName(java.lang.String processName)
void	setProcessVersion(int processVersion)
void	setStateName(java.lang.String stateName)
void	setTokenId(long tokenId)
void	setTokenIds(long[] tokenIds)
AbstractTokenBaseCommand	stateName(java.lang.String stateName)
AbstractTokenBaseCommand	tokenId(long tokenId)
AbstractTokenBaseCommand	tokenIds(long[] tokenIds)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Constructor Detail

AbstractTokenBaseCommand

public AbstractTokenBaseCommand()

Method Detail

getJbpmContext

protected JbpmContext getJbpmContext()

execute

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

Specified by:

execute in interface Command

Throws:

java.lang.Exception

execute

public abstract java.lang.Object execute(Token token)

setTokenIds

public void setTokenIds(long[] tokenIds)

setTokenId

public void setTokenId(long tokenId)

getAdditionalToStringInformation

public java.lang.String getAdditionalToStringInformation()

getProcessName

public java.lang.String getProcessName()

setProcessName

public void setProcessName(java.lang.String processName)

getProcessVersion

public int getProcessVersion()

setProcessVersion

public void setProcessVersion(int processVersion)

getStateName

public java.lang.String getStateName()

setStateName

public void setStateName(java.lang.String stateName)

getTokenIds

public long[] getTokenIds()

getTokenId

public long getTokenId()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

tokenIds

public AbstractTokenBaseCommand tokenIds(long[] tokenIds)

tokenId

public AbstractTokenBaseCommand tokenId(long tokenId)

processName

public AbstractTokenBaseCommand processName(java.lang.String processName)

processVersion

public AbstractTokenBaseCommand processVersion(int processVersion)

stateName

public AbstractTokenBaseCommand stateName(java.lang.String stateName)

isOperateOnSingleObject

public boolean isOperateOnSingleObject()