IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Interface DataExchanger

All Superinterfaces:
PanelActions
All Known Subinterfaces:
DataExchangerWithList, Outsider
All Known Implementing Classes:
SpButtonGroup, SpCheckBox, SpComboBox, SpLabel, SpList, SpMenuBar, SpPasswordField, SpPopupMenu, SpTable, SpTextField

public interface DataExchanger
extends PanelActions

The DataExchanger interface is implemented by any visual bean that holds data.


Method Summary
 void addActionListener(java.awt.event.ActionListener ae)
          Documented in the JDK.
 void addCoordinatedEventListener(CoordinatedEventListener newListener)
          Adds a CoordinatedEventListener.
 void addDataChangedListener(DataChangedListener adl)
          Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))
 java.lang.String getAlternativeDataName()
          Gets the alternativeDataName property value.
 java.lang.String getDataDirection()
          Gets the dataDirection property value.
 java.lang.String getDataName()
          Gets the dataName property value.
 java.lang.Object getDataValue()
          Gets the dataValue property value.
 java.lang.String getErrorMessage()
          Gets the ErrorMessage property value from its formatters (if exists).
 NavigationParameters getNavigationParameters()
          Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 java.lang.String getType()
          Gets the type property (java.lang.String) value.
 boolean hasAlternativeDataName()
          Returns if the data exchanger has alternative data name attribute.
 boolean isInError()
          Returns if the data exchanger is in error or not.
 boolean isKeyedValue()
          if true this bean returns a composed data value.
 boolean isRequired()
          Returns if the data exchanger is mandatory or not.
 void removeActionListener(java.awt.event.ActionListener ae)
          Documented in the JDK.
 void removeCoordinatedEventListener(CoordinatedEventListener newListener)
          Removes a CoordinatedEventListener.
 void removeDataChangedListener(DataChangedListener dcl)
          Unregisters the listener for DataChangedEvent.
 void setAlternativeDataName(java.lang.String o)
          Sets the alternativeDataName property value.
 void setDataDirection(java.lang.String o)
          Sets the dataDirection property value.
 void setDataName(java.lang.String o)
          Sets the dataName property value.
 void setDataValue(java.lang.Object o)
          Sets the dataValue property value.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property value.
 void setNavigationParameters(NavigationParameters navigationParameters)
          Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 void setRequired(boolean req)
          Sets the required property value.
 void setType(java.lang.String type)
          Sets the type property (java.lang.String) value.
 
Methods inherited from interface com.ibm.dse.gui.PanelActions
getDataToClear, getDSECoordinatedPanel, getSpPanel
 

Method Detail

addActionListener

public void addActionListener(java.awt.event.ActionListener ae)
Documented in the JDK.

Parameters:
ae - java.awt.event.ActionEvent

addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds a CoordinatedEventListener.

Parameters:
newListener - CoordinatedEventListener

addDataChangedListener

public void addDataChangedListener(DataChangedListener adl)
Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))

Registers a listener for the DataChangedEvent. When the operation panel is started, it is registered as listener of DataChangedEvents fired by all the data exchangers in the panel.

Parameters:
adl - DataChangedListener

getAlternativeDataName

public java.lang.String getAlternativeDataName()
Gets the alternativeDataName property value.

Returns:
java.lang.String - the data name

getDataDirection

public java.lang.String getDataDirection()
Gets the dataDirection property value.

Returns:
java.lang.String - the data direction

getDataName

public java.lang.String getDataName()
Gets the dataName property value.

Returns:
java.lang.String - the data name

getDataValue

public java.lang.Object getDataValue()
Gets the dataValue property value.

Returns:
Object - the data value

getErrorMessage

public java.lang.String getErrorMessage()
Gets the ErrorMessage property value from its formatters (if exists).

Returns:
java.lang.String - the error message

getNavigationParameters

public NavigationParameters getNavigationParameters()
Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Returns:
The navigationParameters property value.

getType

public java.lang.String getType()
Gets the type property (java.lang.String) value.

Specified by:
getType in interface PanelActions
Returns:
The type property value.

hasAlternativeDataName

public boolean hasAlternativeDataName()
Returns if the data exchanger has alternative data name attribute.

Returns:
boolean - if it has alternative data name atribute

isInError

public boolean isInError()
Returns if the data exchanger is in error or not.

Returns:
boolean - if it is in error or not

isKeyedValue

public boolean isKeyedValue()
if true this bean returns a composed data value.

Returns:
boolean

isRequired

public boolean isRequired()
Returns if the data exchanger is mandatory or not.

Returns:
boolean - if it is mandatory or not

removeActionListener

public void removeActionListener(java.awt.event.ActionListener ae)
Documented in the JDK.

Parameters:
ae - java.awt.event.ActionEvent

removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.

Parameters:
newListener - DataChangedListener

removeDataChangedListener

public void removeDataChangedListener(DataChangedListener dcl)
Unregisters the listener for DataChangedEvent.

Parameters:
dcl - com.ibm.dse.gui.DataChangedListener

setAlternativeDataName

public void setAlternativeDataName(java.lang.String o)
Sets the alternativeDataName property value.

Parameters:
o - java.lang.String, the data name

setDataDirection

public void setDataDirection(java.lang.String o)
Sets the dataDirection property value.

Parameters:
o - java.lang.String, the data direction

setDataName

public void setDataName(java.lang.String o)
Sets the dataName property value.

Parameters:
o - java.lang.String, the data name

setDataValue

public void setDataValue(java.lang.Object o)
Sets the dataValue property value.

Parameters:
o - java.lang.Object, the data value

setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property value.


setNavigationParameters

public void setNavigationParameters(NavigationParameters navigationParameters)
Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Parameters:
navigationParameters - The new value for the property.
See Also:
getNavigationParameters()

setRequired

public void setRequired(boolean req)
Sets the required property value.

Parameters:
req - boolean, true if dataExchanger is required.

setType

public void setType(java.lang.String type)
Sets the type property (java.lang.String) value.

Parameters:
type - The new value for the property.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005