DataExchanger interface description

The DataExchanger interface defines the following methods:
Table 1. DataExchanger interface methods
Method Description
addCoordinatedEventListener (CoordinatedEventListener) This method registers a listener for the DSECoordinationEvents fired by the data exchanger. It is used when the coordinated panel is started: the panel is registered as a listener for DSECoordinationEvents fired by the data exchangers on the coordinated panel.
getAlternativeDataName Gets the alternativeDataName attribute.
getDataDirection() Gets the dataDirection attribute.
getDataName() Gets the dataName attribute.
getDataToClear() Gets the dataToClear property (java.lang.String) value when a DSECoordinationEvent of source type "clear" is fired.
getDataValue() Gets the dataValue attribute. Defines the visible behavior of the particular type of visual part when getting a value. See setDataValue() for example.
getDSECoordinatedPanel() Gets the DSECoordinatedPanel where the component is placed.
GetErrorMessage() Returns the error message for this bean if the isInError() method returns true.
getNavigationParameters() Gets the navigationParameters attribute.
getSpPanel() Gets the SpPanel where the component is placed.
getType() Gets the type attribute.
hasAlternativeDataName() Returns a boolean indicating whether the bean has an alternativeDataName
isInError() Returns a boolean value indicating whether the data entered by the user is valid. It is recommended that the implementation of this method has a default return value of "false". This value is suitable for those visual beans for which it is impossible for the user to enter invalid data. For example, it is impossible to enter invalid data into a CheckBox bean.
isKeyedValue() Returns a boolean. If true, the dataValue of this bean returns a composite data structure. If false, it returns a simple data value.
isRequired() Returns a boolean indicating whether the bean is mandatory.
removeCoordinatedEventListener (DataCoordinatedEventListener) Removes the listener for DSECoordinationEvent.
setAlternativeDataName(String) Sets the alternativeDataName attribute.
setDataDirection() Sets the dataDirection attribute
setDataName(String) Sets the dataName attribute.
setDataValue(Object) Sets the dataValue attribute. Defines the visible behavior of the particular type of visual part when setting a value. For example, the method call SpTextField.setDataValue sets the appropriate text in the entry field; the call SpCheckBox.setDataValue selects or deselects the check box.
setNavigationParameters (NavigationParameters) Sets the navigationParameters attribute.
SetHelpId(String) Sets the HelpID attribute
SetRequired(boolean) Sets the required attribute (or mandatory property)
setType(string) Sets the type attribute.