com.ibm.cics.core.connections
Class AbstractConnectionCustomizer

java.lang.Object
  extended by com.ibm.cics.core.connections.AbstractConnectionCustomizer
All Implemented Interfaces:
IConnectionCustomizer

public abstract class AbstractConnectionCustomizer
extends java.lang.Object
implements IConnectionCustomizer

convenience partial implementation


Constructor Summary
AbstractConnectionCustomizer()
           
 
Method Summary
 void addListener(IConnectionCustomizerListener listener)
          Invoked by the connections framework, which adds an IConnectionCustomizerListener.
 IConnectionsInfoProvider getConnectionPreferencePage()
           
 java.lang.String getDefaultValue(java.lang.String extendedAttributeName)
          Return the default value for an extended attribute
 java.util.List<IConnectionCustomizerListener> getListeners()
           
 boolean performOk()
           
 void removeListener(IConnectionCustomizerListener listener)
          Removes the supplied IConnectionCustomizerListener, if it is currently registered.
 void setConnectionsInfoProvider(IConnectionsInfoProvider provider)
          Invoked by the connections framework to provide a service which can be used to query the connection framework for existing ConnectionConfigurations.
 void setDirty(boolean isDirty)
           
 void setInitializationData(IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
           
 java.lang.String validateEnteredData()
          Called by the connections framework to validate the user data entered into this IConnectionCustomizer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.cics.core.connections.IConnectionCustomizer
clear, createControl, performDefaults, setConfiguration, updateCurrentConfiguration
 

Constructor Detail

AbstractConnectionCustomizer

public AbstractConnectionCustomizer()
Method Detail

getListeners

public java.util.List<IConnectionCustomizerListener> getListeners()
Returns:
the set of listeners on this connection customizer

getConnectionPreferencePage

public IConnectionsInfoProvider getConnectionPreferencePage()
Returns:
the connection preference page hosting the customizer

setInitializationData

public void setInitializationData(IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
                           throws CoreException
Throws:
CoreException

addListener

public void addListener(IConnectionCustomizerListener listener)
Description copied from interface: IConnectionCustomizer
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.

Specified by:
addListener in interface IConnectionCustomizer
Parameters:
listener - the IConnectionCustomizerListener to add.

removeListener

public void removeListener(IConnectionCustomizerListener listener)
Description copied from interface: IConnectionCustomizer
Removes the supplied IConnectionCustomizerListener, if it is currently registered. Has no effect if it is not.

Specified by:
removeListener in interface IConnectionCustomizer

setConnectionsInfoProvider

public void setConnectionsInfoProvider(IConnectionsInfoProvider provider)
Description copied from interface: IConnectionCustomizer
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.

Specified by:
setConnectionsInfoProvider in interface IConnectionCustomizer
Parameters:
provider - the IConnectionsInfoProvider service to use.

performOk

public boolean performOk()
Specified by:
performOk in interface IConnectionCustomizer

setDirty

public void setDirty(boolean isDirty)
Specified by:
setDirty in interface IConnectionCustomizer

validateEnteredData

public java.lang.String validateEnteredData()
Description copied from interface: IConnectionCustomizer
Called by the connections framework to validate the user data entered into this IConnectionCustomizer

Specified by:
validateEnteredData in interface IConnectionCustomizer
Returns:
null if OK, else an error message

getDefaultValue

public java.lang.String getDefaultValue(java.lang.String extendedAttributeName)
Return the default value for an extended attribute

Parameters:
extendedAttributeName - the attribute to return the default attribute name for
Returns:
the default value for the supplied attribute


Copyright © 2013 IBM Corp. All Rights Reserved.