|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.runtime.SpawnOptions
public class SpawnOptions
Container class for options that controls how the spawning operation has to be performed.
| Nested Class Summary | |
|---|---|
static class |
SpawnOptions.SpawnMode
Specifies what action to take with the originating process instance. |
| Field Summary | |
|---|---|
static SpawnOptions |
DEFAULT
The default spawn options used when no options are specified. |
| Constructor Summary | |
|---|---|
SpawnOptions(String comment)
Creates a default spawn options which aborts the source process instance and starts the spawned process with the default start activity and copies all data from the source process instance to the spawned process instance. |
|
SpawnOptions(String startActivity,
boolean abortProcessInstance,
String comment,
DataCopyOptions dataCopyOptions)
Deprecated. use SpawnOptions(String, SpawnMode, String, DataCopyOptions) |
|
SpawnOptions(String startActivity,
SpawnOptions.SpawnMode spawnMode,
String comment,
DataCopyOptions dataCopyOptions)
Creates a new SpawnOptions that allows to specify the starting activity and detailed data copy options. |
|
| Method Summary | |
|---|---|
String |
getComment()
Retrieves the comment associated with the spawning operation. |
DataCopyOptions |
getDataCopyOptions()
Retrieves the options that controls how the data is copied between the originating and the spawned process instance. |
org.eclipse.stardust.engine.api.runtime.ProcessStateSpec |
getProcessStateSpec()
Retrieves the specification of the started activities. |
String |
getStartActivity()
Deprecated. since Stardust 3.0 / I.P.P. 9.0 |
boolean |
isAbortProcessInstance()
Retrieves the processing behavior of the originating process instance. |
boolean |
isHaltProcessInstance()
Retrieves the processing behavior of the originating process instance. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final SpawnOptions DEFAULT
| Constructor Detail |
|---|
public SpawnOptions(String comment)
comment - the spawning comment.
@Deprecated
public SpawnOptions(String startActivity,
boolean abortProcessInstance,
String comment,
DataCopyOptions dataCopyOptions)
SpawnOptions(String, SpawnMode, String, DataCopyOptions)
startActivity - the activity from which the spawned process instance should start.
If null, the spawned process instance will start from the default start activity.abortProcessInstance - use true to abort the originating process instance.comment - a comment describing the operation. May be null.dataCopyOptions - instructions on how the data should be transferred from the
originating process instance to the spawned process instance. If null, then
DataCopyOptions.DEFAULT is used.
public SpawnOptions(String startActivity,
SpawnOptions.SpawnMode spawnMode,
String comment,
DataCopyOptions dataCopyOptions)
startActivity - the activity from which the spawned process instance should start.
If null, the spawned process instance will start from the default start activity.spawnMode - specifies what action to take with the originating process instance. SpawnOptions.SpawnMode.KEEP, SpawnOptions.SpawnMode.ABORT or SpawnOptions.SpawnMode.HALT.comment - a comment describing the operation. May be null.dataCopyOptions - instructions on how the data should be transferred from the
originating process instance to the spawned process instance. If null, then
DataCopyOptions.DEFAULT is used.| Method Detail |
|---|
public String getStartActivity()
public org.eclipse.stardust.engine.api.runtime.ProcessStateSpec getProcessStateSpec()
public boolean isAbortProcessInstance()
public boolean isHaltProcessInstance()
public String getComment()
public DataCopyOptions getDataCopyOptions()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||