com.ibm.cics.core.connections
Interface IConnectionUserInterfaceService


public interface IConnectionUserInterfaceService

A service providing UI constructs for manipulating connections


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ConnectionParameters createConnectionConfiguration(java.lang.String... connectionTypeIds)
          Provides UI for the user to create connection parameters for the supplied connection type IDs.
 Control createConnectionWidget(Composite parent, java.lang.String connectionCategoryId, boolean isInDialogMode)
          Create a connection widget to allow the user to see the connection status, change the active connection, or establish a new connection, for connections in the supplied category Id.
 void createCredentialsConfiguration()
          Show the UI to let the user create credentials
 void displayChangePasswordDialog(java.lang.String credentialsID, IRunnableWithProgress changePasswordRunnable)
          Open a dialog to allow the user to change their password
 void editConnectionCategory(java.lang.String connectionCategory)
          The user has gestured that they want to edit the category Default implementation is to show the user the list of connections if there are any to allow them to copy/create, or if there are none drive the user interface to allow them to create a connection
 void editConnectionParameters(java.lang.String connectionParametersId)
           
 void editCredentialsConfiguration(CredentialsConfiguration credentialsConfiguration)
          Show the UI to let the user edit credentials configuration
 void manageConnections()
          Show the UI to let the user manage connections
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

editConnectionParameters

void editConnectionParameters(java.lang.String connectionParametersId)
Parameters:
connectionParametersId - The id of the connection parameters to edit

createConnectionConfiguration

ConnectionParameters createConnectionConfiguration(java.lang.String... connectionTypeIds)
Provides UI for the user to create connection parameters for the supplied connection type IDs. If one type ID is specified, the IConnectionCustomizer for that connection descriptor is launched. If multiple type IDs are specified, UI is displayed to select one of these type IDs. This allows you to produce UI that can create a variety of connection types within a connection category.

Parameters:
connectionTypeId - the ID of the connection descriptor
Returns:
the newly constructed connection parameters

editConnectionCategory

void editConnectionCategory(java.lang.String connectionCategory)
The user has gestured that they want to edit the category Default implementation is to show the user the list of connections if there are any to allow them to copy/create, or if there are none drive the user interface to allow them to create a connection

Parameters:
connectionCategory - - The ID of the connection category, e.g. CICS or z/OS

manageConnections

void manageConnections()
Show the UI to let the user manage connections


editCredentialsConfiguration

void editCredentialsConfiguration(CredentialsConfiguration credentialsConfiguration)
Show the UI to let the user edit credentials configuration

Parameters:
credentialsConfiguration - The ID of the connection descriptor

createCredentialsConfiguration

void createCredentialsConfiguration()
Show the UI to let the user create credentials


createConnectionWidget

Control createConnectionWidget(Composite parent,
                               java.lang.String connectionCategoryId,
                               boolean isInDialogMode)
Create a connection widget to allow the user to see the connection status, change the active connection, or establish a new connection, for connections in the supplied category Id. Clients will need to set layout data on the supplied control as appropriate for the parent composite's layout.

Parameters:
parent - the parent Composite
connectionCategoryId - the category to show connections for
isInDialogMode - whether to hide content that cannot be accessed from a modal context
Returns:
the control of the connection widget

displayChangePasswordDialog

void displayChangePasswordDialog(java.lang.String credentialsID,
                                 IRunnableWithProgress changePasswordRunnable)
Open a dialog to allow the user to change their password

Parameters:
descriptorID -
connectionId -


Copyright © 2013 IBM Corp. All Rights Reserved.