de.aristaflow.adept2.ui.remotegui

Class AbstractTransferableGUIContext

java.lang.Object

de.aristaflow.adept2.ui.remotegui.AbstractTransferableGUIContext

All Implemented Interfaces:

Localiser, GUIContext, de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext, java.io.Serializable

Direct Known Subclasses:

TransferredURLContext

public class AbstractTransferableGUIContext
extends java.lang.Object
implements de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

A basic implementation for a TransferableGUIContext just enough to satisfy the interface. Subclasses should provide more information to allow for creating a local GUI context for a remote execution. This information also needs to be provided via getGUIContextAttributes() so subclasses should override this method.

Author:

Ulrich Kreher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EBPInstanceReference	activity The EBPInstanceReference identifying the process instance node this GUI context has been created for.
protected ActivityInstance	activityInstance The activity instance this GUI context has been created for.
protected ExecutionContext	executionContext The execution context of the activity for which this GUI context has been created for.
protected java.util.Locale	locale The locale of the agent requesting this GUI context.
protected java.lang.String	sessionID The ID of the execution session this GUI context has been created for uniquely identifying the component execution on the (remote) runtime manager).
protected java.lang.String	transfrdGUIContextID The ID of transferred GUI context which may differ from that provided and requested by the activity instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTransferableGUIContext(AbstractTransferableGUIContext context) Creates a new instance of the base implementation of a TransferableGUIContext having the fields of the designated GUI context.
protected	AbstractTransferableGUIContext(ActivityInstance activityInstance, EBPInstanceReference activity, java.lang.String sessionID, ExecutionContext executionContext, java.lang.String transfrdGUIContextID) Creates a new instance of the base implementation of a TransferableGUIContext having the designated fields.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the GUI for this context.
ActivityInstance	getActivityInstance()
EBPInstanceReference	getEBPInstanceReference()
ExecutionContext	getExecutionContext()
java.util.Map<java.lang.String,java.lang.String>	getGUIContextAttributes() Always returns the empty map.
java.util.Locale	getLocale() Gets the Locale that should be used or that is used for localisation of this object or a related object.
java.lang.String	getSessionID()
java.lang.String	getTransferredGUIContextID()

Methods inherited from class java.lang.Object

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

Field Detail

activityInstance

protected final ActivityInstance activityInstance

The activity instance this GUI context has been created for.

locale

protected final java.util.Locale locale

The locale of the agent requesting this GUI context. This will be null if the activity instance should not be localised.

activity

protected final EBPInstanceReference activity

The EBPInstanceReference identifying the process instance node this GUI context has been created for.

sessionID

protected final java.lang.String sessionID

The ID of the execution session this GUI context has been created for uniquely identifying the component execution on the (remote) runtime manager).

executionContext

protected final ExecutionContext executionContext

The execution context of the activity for which this GUI context has been created for.

transfrdGUIContextID

protected final java.lang.String transfrdGUIContextID

The ID of transferred GUI context which may differ from that provided and requested by the activity instance.

Constructor Detail

AbstractTransferableGUIContext

protected AbstractTransferableGUIContext(ActivityInstance activityInstance,
                                         EBPInstanceReference activity,
                                         java.lang.String sessionID,
                                         ExecutionContext executionContext,
                                         java.lang.String transfrdGUIContextID)

Creates a new instance of the base implementation of a TransferableGUIContext having the designated fields.

Parameters:

activityInstance - The activity instance this GUI context has been created for.

activity - The EBPInstanceReference identifying the process instance node this GUI context has been created for.

sessionID - The ID of the execution session this GUI context has been created for uniquely identifying the component execution on the (remote) runtime manager).

executionContext - The execution context of the activity for which this GUI context has been created for.

transfrdGUIContextID - The ID of transferred GUI context which may differ from that provided and requested by the activity instance.

AbstractTransferableGUIContext

protected AbstractTransferableGUIContext(AbstractTransferableGUIContext context)

Creates a new instance of the base implementation of a TransferableGUIContext having the fields of the designated GUI context.

Parameters:

context - The GUI context from which to retrieve the fields.

Method Detail

getActivityInstance

public ActivityInstance getActivityInstance()

Specified by:

getActivityInstance in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

getLocale

public java.util.Locale getLocale()

Description copied from interface: Localiser

Gets the Locale that should be used or that is used for localisation of this object or a related object.

Specified by:

getLocale in interface Localiser

Returns:

The Locale that should be used or that is used for localisation of this object or a related object.

getEBPInstanceReference

public EBPInstanceReference getEBPInstanceReference()

Specified by:

getEBPInstanceReference in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

getSessionID

public java.lang.String getSessionID()

Specified by:

getSessionID in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

getExecutionContext

public ExecutionContext getExecutionContext()

Specified by:

getExecutionContext in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

getTransferredGUIContextID

public java.lang.String getTransferredGUIContextID()

Specified by:

getTransferredGUIContextID in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

getGUIContextAttributes

public java.util.Map<java.lang.String,java.lang.String> getGUIContextAttributes()

Always returns the empty map.

Specified by:

getGUIContextAttributes in interface de.aristaflow.adept2.model.runtimeenvironment.guicontext.TransferableGUIContext

close

public void close()

Closes the GUI for this context. This method has to be called by the runtime manager whenever an application has terminated (finished, failed, aborted, killed,...).
It must be possible to call this method more than once, even if the GUIContext has already shut down. This especially applies to the disposal of SWT-widgets, that is, it is allowed to call this method after the disposal of the corresponding widgets. This is an empty implementation since subclasses are usually only used for transferring the GUI context from the executing runtime manager to the displaying client.

Specified by:

close in interface GUIContext