com.ibm.eNetwork.ECL
Interface ECLRecoNotify

public interface ECLRecoNotify

ECLRecoNotify can be used to implement an object which will receive and handle ECLScreenReco events. Events are generated whenever any screen in the PS is matched to an ECLScreenDesc object in ECLScreenReco. Special events are generated when event generation stops and when errors occur during event generation.

To be notified of ECLScreenReco events, the application must perform the following steps:

1. Define a class which implements the ECLRecoNotify interface.
2. Implement the NotifyEvent(), NotifyStop(), and NotifyError() methods.
3. Create an instance of the new class.
4. Register the instance with the ECLScreenReco.RegisterScreen() method.

See Also:

ECLScreenReco, ECLScreenDesc

Method Summary

void	NotifyError(ECLPS ps, ECLScreenDesc sd, ECLErr e) The NotifyError() method is called whenever the ECLScreenReco object detects an error during event generation.
void	NotifyEvent(ECLPS ps, ECLScreenDesc sd) The NotifyEvent() method is called whenever any screen in the PS is matched to an ECLScreenDesc object in ECLScreenReco.
void	NotifyStop(ECLScreenDesc sd, int reason) The NotifyStop() method is called when event generation is stopped for any reason.

Method Detail

NotifyEvent

public void NotifyEvent(ECLPS ps,
                        ECLScreenDesc sd)

The NotifyEvent() method is called whenever any screen in the PS is matched to an ECLScreenDesc object in ECLScreenReco.

Parameters:

ps - The presentation space where the screen was recognized

sd - The ECLScreenDesc object that was matched

See Also:

ECLPS, ECLScreenDesc

NotifyStop

public void NotifyStop(ECLScreenDesc sd,
                       int reason)

The NotifyStop() method is called when event generation is stopped for any reason. Event generation might be stopped because of an error condition or because the ECLScreenReco.UnregisterScreen() method was called.

Parameters:

sd - The ECLScreenDesc object that was unregistered or in error

reason - This parameter is not currently used.

NotifyError

public void NotifyError(ECLPS ps,
                        ECLScreenDesc sd,
                        ECLErr e)

The NotifyError() method is called whenever the ECLScreenReco object detects an error during event generation. An ECLErr object containing information about the error is passed to this method. If event generation stops due to an error, the NotifyStop() method is also called.

Parameters:

ps - The presentation space that is in error (may be null)

sd - The ECLScreenDesc object that is in error

e - The ECLErr object containing error data.

See Also:

ECLErr, NotifyStop(com.ibm.eNetwork.ECL.ECLScreenDesc, int)