com.ibm.cics.core.connections
Interface IConnectionCustomizer

All Known Implementing Classes:
AbstractConnectionCustomizer

public interface IConnectionCustomizer

Provides a user interface for modifying connection configurations associated with a specific connection type.

Connection customizers should be registered and bound to a specific connection type using the com.ibm.cics.core.connections.connectionCustomizers extension point.

Clients should not directly implement this interface, instead extending AbstractConnectionCustomizer


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addListener(IConnectionCustomizerListener aListener)
          Invoked by the connections framework, which adds an IConnectionCustomizerListener.
 void clear()
          Invoked by the connection framework to clear any existing data in the controls for this IConnectionCustomizer.
 void createControl(Composite parent)
          Creates the SWT controls for this connection customizer.
 void performDefaults()
          Deprecated. no longer used.
 boolean performOk()
          Deprecated. no longer used.
 void removeListener(IConnectionCustomizerListener aListener)
          Removes the supplied IConnectionCustomizerListener, if it is currently registered.
 void setConfiguration(ConnectionConfiguration connectionConfiguration)
          Sets the ConnectionConfiguration that should be modified when making changes through this IConnectionCustomizer
 void setConnectionsInfoProvider(IConnectionsInfoProvider provider)
          Deprecated. 
 void setDirty(boolean isDirty)
          Deprecated. 
 void updateCurrentConfiguration()
          The implementation should write the data from the UI to the extended attributes in the configuration set by setConfiguration(ConnectionConfiguration)
 java.lang.String validateEnteredData()
          Called by the connections framework to validate the user data entered into this IConnectionCustomizer
 

Field Detail

COPYRIGHT

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

setConfiguration

void setConfiguration(ConnectionConfiguration connectionConfiguration)
Sets the ConnectionConfiguration that should be modified when making changes through this IConnectionCustomizer

Parameters:
connectionConfiguration - the ConnectionConfiguration to be modified.

createControl

void createControl(Composite parent)
Creates the SWT controls for this connection customizer.

Clients should not call this method, it will be called by the connection framework when this class is initialized.

Parameters:
parent - parent composite to use.

performOk

@Deprecated
boolean performOk()
Deprecated. no longer used.


setDirty

@Deprecated
void setDirty(boolean isDirty)
Deprecated. 


addListener

void addListener(IConnectionCustomizerListener aListener)
Invoked by the connections framework, which adds an IConnectionCustomizerListener. This listener should be notified with property change events, and will be used to trigger revalidation.

Parameters:
aListener - the IConnectionCustomizerListener to add.

removeListener

void removeListener(IConnectionCustomizerListener aListener)
Removes the supplied IConnectionCustomizerListener, if it is currently registered. Has no effect if it is not.

Parameters:
aListener -

clear

void clear()
Invoked by the connection framework to clear any existing data in the controls for this IConnectionCustomizer.


performDefaults

@Deprecated
void performDefaults()
Deprecated. no longer used.


setConnectionsInfoProvider

@Deprecated
void setConnectionsInfoProvider(IConnectionsInfoProvider provider)
Deprecated. 

Invoked by the connections framework to provide a service which can be used to query the connection framework for existing ConnectionConfigurations. Clients should prefer to use IConnectionManager directly to access data for ConnectionProfiles.

Parameters:
provider - the IConnectionsInfoProvider service to use.

updateCurrentConfiguration

void updateCurrentConfiguration()
The implementation should write the data from the UI to the extended attributes in the configuration set by setConfiguration(ConnectionConfiguration)

Any data witten to the ConnectionConfiguration will be persisted by the connections framework.


validateEnteredData

java.lang.String validateEnteredData()
Called by the connections framework to validate the user data entered into this IConnectionCustomizer

Returns:
null if OK, else an error message


Copyright © 2013 IBM Corp. All Rights Reserved.