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

java.lang.Object
  org.eclipse.stardust.engine.api.runtime.SpawnOptions

All Implemented Interfaces:

java.io.Serializable

public class SpawnOptions
extends java.lang.Object
implements java.io.Serializable

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

Version:

$Revision: $

Author:

Florin.Herinean

See Also:

Serialized Form

Field Summary

static SpawnOptions

DEFAULT The default spawn options used when no options are specified.

Constructor Summary

SpawnOptions(java.lang.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(java.lang.String startActivity, boolean abortProcessInstance, java.lang.String comment, DataCopyOptions dataCopyOptions)
Creates a new SpawnOptions that allows to specify the starting activity and detailed data copy options.

Method Summary

java.lang.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.
java.lang.String	getStartActivity() Retrieves the starting activity id.
boolean	isAbortProcessInstance() 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(java.lang.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

public SpawnOptions(java.lang.String startActivity,
                    boolean abortProcessInstance,
                    java.lang.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.

abortProcessInstance - true to abort the originating process instance. Currently only a value of true is accepted for processing.

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 java.lang.String getStartActivity()

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.

isAbortProcessInstance

public boolean isAbortProcessInstance()

Retrieves the processing behavior of the originating process instance.

Returns:

true, if the originating process instance should be aborted, false if it should be completed.

getComment

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