org.eclipse.stp.core.saf
Interface IUIContext


public interface IUIContext

This is the interface of the UI context object that the user program needs to create and pass in as an argument to several methods provided by the handler interfaces. This interface allows handlers to obtain the UI shell instance needed to interact with the user program.


Method Summary
 java.lang.String createName(java.lang.String testName, org.eclipse.stp.core.sca.SCAObject objectType)
          This method will evaluate the uniqueness of the given test name within the context for which this callback class was instantiated.
 java.lang.Object getShell()
          Returns an instance of the UI shell object representing the windows that the desktop or window manager is managing - see Shell
 

Method Detail

getShell

public java.lang.Object getShell()
Returns an instance of the UI shell object representing the windows that the desktop or window manager is managing - see Shell

Returns:
UI Shell

createName

public java.lang.String createName(java.lang.String testName,
                                   org.eclipse.stp.core.sca.SCAObject objectType)
This method will evaluate the uniqueness of the given test name within the context for which this callback class was instantiated. For instance, if the test name is for a component, it will be checked to ensure it represents a unique component name within a given Module. If the name is unique, it will be returned as is. Otherwise, it will be modified to be unique and then returned.

Parameters:
testName - the name to test for the given object type
objectType - the Component, EntryPoint or ExternalService for which the name must be unique
Returns:
a unique name