org.eclipse.stardust.engine.api.runtime

Class SpawnOptions

java.lang.Object

org.eclipse.stardust.engine.api.runtime.SpawnOptions

All Implemented Interfaces:

Serializable

public class SpawnOptions
extends Object
implements Serializable

Container class for options that controls how the spawning operation has to be performed.

Author:

Florin.Herinean

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpawnOptions.SpawnMode Specifies what action to take with the originating process instance.

Field Summary

Fields

Modifier and Type	Field and Description
static SpawnOptions	DEFAULT The default spawn options used when no options are specified.

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
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

DEFAULT

public static final SpawnOptions DEFAULT

The default spawn options used when no options are specified.

Constructor Detail

SpawnOptions

public 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.

Parameters:

comment - the spawning comment.

SpawnOptions

@Deprecated
public SpawnOptions(String startActivity,
                       boolean abortProcessInstance,
                       String comment,
                       DataCopyOptions dataCopyOptions)

Deprecated. use SpawnOptions(String, SpawnMode, String, DataCopyOptions)

Creates a new SpawnOptions that allows to specify the starting activity and detailed data copy options.

Parameters:

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.

SpawnOptions

public 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.

Parameters:

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

getStartActivity

public String getStartActivity()

Deprecated. since Stardust 3.0 / I.P.P. 9.0

Retrieves the starting activity id. May be null, in which case the spawned process should start with the default starting activity.

Returns:

the id of the activity from which the spawned process instance will start.

getProcessStateSpec

public org.eclipse.stardust.engine.api.runtime.ProcessStateSpec getProcessStateSpec()

Retrieves the specification of the started activities.

Returns:

the specification of the started activities.

isAbortProcessInstance

public boolean isAbortProcessInstance()

Retrieves the processing behavior of the originating process instance.

Returns:

true, if the originating process instance should be aborted.

isHaltProcessInstance

public boolean isHaltProcessInstance()

Retrieves the processing behavior of the originating process instance.

Returns:

true, if the originating process instance should be halted.

getComment

public String getComment()

Retrieves the comment associated with the spawning operation.

Returns:

the comment or null.

getDataCopyOptions

public DataCopyOptions getDataCopyOptions()

Retrieves the options that controls how the data is copied between the originating and the spawned process instance.

Returns:

a DataCopyOptions or null if the default options are to be used.