All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.eNetwork.ECL.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:
- Define a class which implements the ECLRecoNotify interface.
- Implement the NotifyEvent(), NotifyStop(), and NotifyError() methods.
- Create an instance of the new class.
- Register the instance with the ECLScreenReco.RegisterScreen() method.
- See Also:
- ECLScreenReco, ECLScreenDesc
-
NotifyError(ECLPS, ECLScreenDesc, ECLErr)
- The NotifyError() method is called whenever the ECLScreenReco object
detects an error during event generation.
-
NotifyEvent(ECLPS, ECLScreenDesc)
- The NotifyEvent() method is called whenever any screen
in the PS is matched to an ECLScreenDesc object in ECLScreenReco.
-
NotifyStop(ECLScreenDesc, int)
- The NotifyStop() method is called when event generation is stopped
for any reason.
NotifyEvent
public abstract 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 abstract 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 abstract 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
All Packages Class Hierarchy This Package Previous Next Index