com.ibm.eNetwork.ECL.screenreco.event
Class ECLRecoDebugEvent

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.event.ECLEvent
        |
        +--com.ibm.eNetwork.ECL.screenreco.event.ECLRecoDebugEvent

public class ECLRecoDebugEvent

extends ECLEvent

Event fired to objects implementing ECLRecoDebugListener interface (must call ECLScreenReco.AddECLRecoDebugListener). This event contains all the functionality for discovering how the screen matching logic performed.

To use this class properly, follow these steps:

1. Implement the ECLRecoDebugListener and add it to Macro using ECLScreenReco.AddECLRecoDebugListener.
2. In the Compared method, first determine if the screen matched by calling ECLRecoDebugEvent.IsMatch().
3. If the match was not successful, get the ECLScreenDesc object using ECLRecoDebugEvent.GetDescription().
4. Get the vector of descriptors for the description by call GetDescriptors on object you received from the previous step.
5. From there, you can iterate through each descriptor in the vector, calling IsMatch() on each to determine which failed.
6. If failure occurred, you can call ECLRecoDebugEvent.CompareDescriptor to determine what is actually in the PS that caused the descriptor to fail.

See Also:

ECLRecoDebugListener, ECLScreenReco

Constructor Summary

ECLRecoDebugEvent(ECLScreenReco arg0, ECLPS arg1, ECLScreenDesc arg2)
Constructs a working instance of a MacroDebugRecoEvent.

Method Summary

ECLScreenDescriptor	CompareDescriptor(ECLScreenDescriptor arg) Returns what is actually on the host screen based on the parameters passed in the descriptor.
java.lang.String	FormatSDString(ECLSDString sds) This method should be used in conjunction with the CompareDescriptor method.
ECLScreenDesc	GetDescription() Returns the ECLScreenDesc object that was compared.
ECLPS	GetPS() Returns the current presentation space object in the Macro bean.
boolean	IsMatch() Returns true if all match.

Methods inherited from class com.ibm.eNetwork.ECL.event.ECLEvent

GetSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ECLRecoDebugEvent

public ECLRecoDebugEvent(ECLScreenReco arg0,
                         ECLPS arg1,
                         ECLScreenDesc arg2)

Constructs a working instance of a MacroDebugRecoEvent. This constructor can only be used by classes in the HOD beans package.

Method Detail

GetDescription

public ECLScreenDesc GetDescription()

Returns the ECLScreenDesc object that was compared.

Returns:

ECLScreenDesc object compared

GetPS

public ECLPS GetPS()

Returns the current presentation space object in the Macro bean. Provided for developer convenience.

Returns:

ECLPS object that the screens were compared against

IsMatch

public boolean IsMatch()

Returns true if all match. Provided for developer convenience.

Returns:

boolean true if all ECLScreenDescriptors match

CompareDescriptor

public ECLScreenDescriptor CompareDescriptor(ECLScreenDescriptor arg)
                                      throws ECLErr

Returns what is actually on the host screen based on the parameters passed in the descriptor. Useful to know what is actually on the screen if a descriptor failed.

Note: for ECLSDString objects that are set as strings in rectangular areas, the entire text of the rectangular area needs to be returned. To usefully display the actual contents of the screen, use the FormatSDString method on this object. This will return an XML string with the contents of the screen rectangle properly formatted.

Returns:

ECLScreenDescriptor object that is currently on the screen

Throws:

ECLErr - Thrown on HACL error.

FormatSDString

public java.lang.String FormatSDString(ECLSDString sds)

This method should be used in conjunction with the CompareDescriptor method. For ECLSDString objects that are set as strings in rectangular areas, the entire text of the rectangular area needs to be returned. To usefully display the actual contents of the screen, use the FormatSDString method on this object. This will return an XML string with the contents of the screen rectangle properly formatted.