org.jbpm.command
Class NewProcessInstanceCommand

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

All Implemented Interfaces:

Serializable, Command

Direct Known Subclasses:

StartProcessInstanceCommand

public class NewProcessInstanceCommand
extends AbstractBaseCommand

Graph command to start a new process and create a task instance if the start node has a start task definition. The result of this command, if requested, is a Long value containing the process instance id.

Author:

Jim Rigsbee, Tom Baeyens, Bernd Ruecker

See Also:

Serialized Form

Constructor Summary

NewProcessInstanceCommand()

NewProcessInstanceCommand(String processDefinitionName)

Method Summary

NewProcessInstanceCommand	actorId(String actorId)
NewProcessInstanceCommand	createStartTask(boolean createStartTask)
Object	execute(JbpmContext jbpmContext) return the id of the newly created process instance.
String	getActorId()
String	getAdditionalToStringInformation()
String	getKey()
long	getProcessDefinitionId()
String	getProcessDefinitionName()
long	getProcessId() Deprecated. use getProcessDefinitionId instead
String	getProcessName() Deprecated. use getProcessDefinitionName instead
Map	getVariables()
boolean	isCreateStartTask()
NewProcessInstanceCommand	key(String key)
NewProcessInstanceCommand	processDefinitionId(long processId)
NewProcessInstanceCommand	processDefinitionName(String processName)
void	setActorId(String actorId)
void	setCreateStartTask(boolean createStartTask)
void	setKey(String key)
void	setProcessDefinitionId(long processId)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessId(long processId) Deprecated. use setProcessDefinitionId instead
void	setProcessName(String processName) Deprecated. use setProcessDefinitionName instead
void	setVariables(Map variables)
NewProcessInstanceCommand	variables(Map variables)

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

NewProcessInstanceCommand

public NewProcessInstanceCommand()

NewProcessInstanceCommand

public NewProcessInstanceCommand(String processDefinitionName)

Method Detail

execute

public Object execute(JbpmContext jbpmContext)
               throws Exception

return the id of the newly created process instance.

Throws:

Exception

getActorId

public String getActorId()

setActorId

public void setActorId(String actorId)

getProcessDefinitionId

public long getProcessDefinitionId()

setProcessDefinitionId

public void setProcessDefinitionId(long processId)

getProcessId

public long getProcessId()

Deprecated. use getProcessDefinitionId instead

setProcessId

public void setProcessId(long processId)

Deprecated. use setProcessDefinitionId instead

getProcessName

public String getProcessName()

Deprecated. use getProcessDefinitionName instead

setProcessName

public void setProcessName(String processName)

Deprecated. use setProcessDefinitionName instead

isCreateStartTask

public boolean isCreateStartTask()

setCreateStartTask

public void setCreateStartTask(boolean createStartTask)

getVariables

public Map getVariables()

getProcessDefinitionName

public String getProcessDefinitionName()

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

setVariables

public void setVariables(Map variables)

getKey

public String getKey()

setKey

public void setKey(String key)

getAdditionalToStringInformation

public String getAdditionalToStringInformation()

Overrides:

getAdditionalToStringInformation in class AbstractBaseCommand

actorId

public NewProcessInstanceCommand actorId(String actorId)

processDefinitionId

public NewProcessInstanceCommand processDefinitionId(long processId)

processDefinitionName

public NewProcessInstanceCommand processDefinitionName(String processName)

createStartTask

public NewProcessInstanceCommand createStartTask(boolean createStartTask)

variables

public NewProcessInstanceCommand variables(Map variables)

key

public NewProcessInstanceCommand key(String key)