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:
- Implement the MacroDebugListener and add it to Macro using Macro.addMacroDebugListener.
- In the screensCompared method, first determine if the screen matched by
calling MacroRecoDebugEvent.isMatch().
- If the match was not successful, get the ECLScreenDesc object using MacroRecoDebugEvent.getDescription().
- Get the vector of descriptors for the description by call GetDescriptors on
object you received from the previous step.
- From there, you can iterate through each descriptor in the vector, calling
IsMatch() on each to determine which failed.
- If failure occurred, you can call MacroRecoDebugEvent.getActual to determine
what is actually in the PS that caused the descriptor to fail.
-
MacroRecoDebugEvent(ECLScreenReco, ECLPS, ECLScreenDesc)
- Constructs a working instance of a MacroRecoDebugEvent.
-
MacroRecoDebugEvent(Macro, ECLRecoDebugEvent, MacroScreens, MacroScreen)
- Constructs a working instance of a MacroRecoDebugEvent.
-
formatSDString(ECLSDString)
- This method should be used in conjunction with the getActual method.
-
getActual(ECLScreenDescriptor)
- Returns the what is actually on the host screen based on the parameters
passed in the descriptor.
-
getCurrentPS()
- Returns the current presentation space object in the Macro bean.
-
getDescription()
- Returns the ECLScreenDesc object that is in the MacroScreen compared.
-
getScreen()
- Returns the MacroScreen object for the event
-
getScreenLineNum()
- Returns the line number of the MacroScreen object for the event
-
getScreens()
- Returns MacroScreens object for the event.
-
isMatch()
- Returns true if all match.
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.
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.
getScreens
public MacroScreens getScreens()
- Returns MacroScreens object for the event.
- Returns:
- MacroScreens collection object currently in the Macro bean
- See Also:
- MacroScreens
getScreen
public MacroScreen getScreen()
- Returns the MacroScreen object for the event
- Returns:
- MacroActions collection object currently in the Macro bean
- See Also:
- MacroScreen
getScreenLineNum
public int getScreenLineNum()
- Returns the line number of the MacroScreen object for the event
- Returns:
- line number for the screen
getDescription
public ECLScreenDesc getDescription()
- Returns the ECLScreenDesc object that is in the MacroScreen compared.
- Returns:
- ECLScreenDesc object of the MacroScreen in the event
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
isMatch
public boolean isMatch()
- Returns true if all match. Provided for developer convenience.
- Returns:
- boolean true if all ECLScreenDescriptors match
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.
- Parameters:
- arg - ECLScreenDescriptor the screen descriptor for which the actual current state in the session should be returned. e.g, if thescreen descriptor is ECLSDCursor, a new ECLSDCursor is returned with the current row and column cursor values
- Returns:
- ECLScreenDescriptor object that is currently on the screen
formatSDString
public String formatSDString(ECLSDString sds)
- This method should be used in conjunction 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