All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.event.MacroRecoDebugEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroRecoDebugEvent

public class MacroRecoDebugEvent
extends HODEvent
Event fired to objects implementing MacroDebugListener interface (must call Macro.addMacroDebugListener). This event contains all the functionality for discovering how the Macro screen matching logic performed.

To use this class properly, follow these steps:

  1. Implement the MacroDebugListener and add it to Macro using Macro.addMacroDebugListener.
  2. In the screensCompared method, first determine if the screen matched by calling MacroRecoDebugEvent.isMatch().
  3. If the match was not successful, get the ECLScreenDesc object using MacroRecoDebugEvent.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 occured, you can call MacroRecoDebugEvent.getActual to determine what is actually in the PS that caused the descriptor to fail.


Constructor Index

 o MacroRecoDebugEvent(ECLScreenReco, ECLPS, ECLScreenDesc)
Constructs a working instance of a MacroRecoDebugEvent.
 o MacroRecoDebugEvent(Macro, ECLRecoDebugEvent, MacroScreens, MacroScreen)
Constructs a working instance of a MacroRecoDebugEvent.

Method Index

 o formatSDString(ECLSDString)
This method should be used in conjuction with the getActual method.
 o getActual(ECLScreenDescriptor)
Returns the what is actually on the host screen based on the parameters passed in the descriptor.
 o getCurrentPS()
Returns the current presentation space object in the Macro bean.
 o getDescription()
Returns the ECLScreenDesc object that is in the MacroScreen compared.
 o getScreen()
Returns the MacroScreen object for the event
 o getScreenLineNum()
Returns the line number of the MacroScreen object for the event
 o getScreens(MacroScreens)
Returns MacroScreens object for the event.
 o isMatch()
Returns true if all match.

Constructors

 o MacroRecoDebugEvent
 public MacroRecoDebugEvent(ECLScreenReco arg0,
                            ECLPS arg1,
                            ECLScreenDesc arg2)
Constructs a working instance of a MacroRecoDebugEvent. This constructor should only be used by classes in the HOD beans package.

 o MacroRecoDebugEvent
 public MacroRecoDebugEvent(Macro arg0,
                            ECLRecoDebugEvent arg1,
                            MacroScreens arg2,
                            MacroScreen arg3)
Constructs a working instance of a MacroRecoDebugEvent. This constructor should only be used by classes in the HOD beans package.

Methods

 o getScreens
 public MacroScreens getScreens(MacroScreens mss)
Returns MacroScreens object for the event.

Returns:
MacroScreens collection object currently in the Macro bean
See Also:
MacroScreens
 o getScreen
 public MacroScreen getScreen()
Returns the MacroScreen object for the event

Returns:
MacroActions collection object currently in the Macro bean
See Also:
MacroScreen
 o getScreenLineNum
 public int getScreenLineNum()
Returns the line number of the MacroScreen object for the event

Returns:
line number for the screen
 o getDescription
 public ECLScreenDesc getDescription()
Returns the ECLScreenDesc object that is in the MacroScreen compared.

Returns:
ECLScreenDesc object of the MacroScreen in the event
 o getCurrentPS
 public ECLPS getCurrentPS()
Returns the current presentation space object in the Macro bean. Provided for developer convenience.

Returns:
ECLPS object contained in the Macro bean
 o isMatch
 public boolean isMatch()
Returns true if all match. Provided for developer convenience.

Returns:
boolean true if all ECLScreenDescriptors match
 o getActual
 public ECLScreenDescriptor getActual(ECLScreenDescriptor arg) throws ECLErr
Returns the 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.

Returns:
ECLScreenDescriptor object that is currently on the screen
 o formatSDString
 public String formatSDString(ECLSDString sds)
This method should be used in conjuction with the getActual 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.


All Packages  Class Hierarchy  This Package  Previous  Next  Index