org.csstudio.startup.module
Interface WorkspaceExtPoint

All Superinterfaces:

CSSStartupExtensionPoint

public interface WorkspaceExtPoint
extends CSSStartupExtensionPoint

WorkspacePromptExtPoint defines how the workspace for the application is loaded. There can be only one extension point of this type in the application.

Author:

Jaka Bobnar

NAME

static final java.lang.String NAME

The name of this extension point element

See Also:

Constant Field Values

WORKSPACE

static final java.lang.String WORKSPACE

The tag under which the workspace URL should be stored in the parameters

See Also:

Constant Field Values

promptForWorkspace

java.lang.Object promptForWorkspace(Display display,
                                    IApplicationContext context,
                                    java.util.Map<java.lang.String,java.lang.Object> parameters)
                                    throws java.lang.Exception

Selects the appropriate workspace according to the given parameters. If the the workspace cannot be selected automatically the implementation should ask the user to define it.

Parameters:

display - the display of the application

context - the context of the application

parameters - contains additional parameters, which can define some special behaviour during the execution of this method (the keys are parameters names and the values are parameters values)

Returns:

the exit code if something happened which requires to exit or restart application or null if everything is alright

Throws:

java.lang.Exception - if an error occurred during the operation