|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.eNetwork.beans.HOD.HODBean | +--com.ibm.eNetwork.beans.HOD.Macro
Macro bean
contains functionality for playing and recording host terminal
user actions when it is wired to either a Terminal bean or a Session bean.
Think of the Macro bean as a state machine engine within the host screen domain. That is, a macro that is played by the Macro bean should be thought of as a series of screens and the actions for those screens. When the macro "sees" a screen in the host presentation space, the actions will be executed for that screen. If there are "next" screens specified with the current screen, the Macro bean checks any further screens from the host against the next screens for the current screen. If there is a match, the cycle continues. If there isn't a match, the macro ends in error. If there are no next screens specified, any screen is valid. This cycle continues until a screen is encountered that is specified as a stop screen. Note: if a start screen is specified (and there can be only one) the macro will not start playing unless the start screen matches.
It follows then that a macro is a series of screen statements. These screen statements each have 3 main elements: the description, the actions, and the next screens. The description is used to describe how the screen looks. Keywords, host screen attributes, field count, OIA state, and cursor position are the main ways to describe a screen. The actions are the steps the Macro bean should take when it "sees" a screen that matches the description. Actions can be keystrokes, data extraction, prompts, and user messages, among others. Note that the Macro bean ignores any screen changes while actions are being executed. The next screens are optional and are basically just pointers to valid next screens after the actions take place. Next screens must correspond to existing screens in the macro and are the way to enforce control flow from screen to screen.
The preferred language for Macro bean is XML. The Macro bean generates and parses macros as XML. All the developer needs to do is call the Macro.setMacro method with the XML string and the Macro bean will parse the macro if it is syntactically correct. Refer to the macro XML syntax document for details on how to write XML macros.
The Macro bean also supports the deprecated Host On-Demand Version 3.0 language but further use of this language is not encouraged. You may not save recorded macros from the Macro bean using the Version 3.0 syntax.
You are not limited to XML or the Version 3.0 language. If you want, you can implement your own parser in conjunction with the Macro bean. The parser you implement must keep the concept of screens and their actions. This is the only restriction. This is possible because the internal storage representation of a macro is contained in the MacroScreens class, which has its own method called Macro.setParsedMacro. Macro can be initialized with a macroScreens object using the setParsedMacro method.
The exposure of the MacroScreens class offers another benefit. You can skip the parsing step if you already have a working macro that you want to use again (for example, server side Java). MacroScreens is serializable, so all you need to do is call Macro.getParsedMacro and serialize and save the MacroScreens object returned. By skipping the parsing step, you remove all the overhead from parsing in your application. See the MacroScreens description for more information on the use of this class.
There are three basic ways to get a working macro: let the Macro bean record it, load in a previously written XML file, or assemble a MacroScreens object correctly yourself.
If you use the record feature of the Macro bean, any host interaction by the user will be recorded automatically. This is limited to rudimentary screen descriptions and keystrokes. You must design your application to take advantage of the other features of the Macro bean such as screen data extraction, detailed screen descriptions, prompting and so forth. There are methods on the Macro bean that your application can call while the bean is in record mode (insertPrompt, insertDataExtract, etc).
Also, you can set up the Macro bean with an XML file and it will parse the file for you. This requires a syntactically correct file, which you can check at runtime using the MacroParseListener/MacroParseEvent model. If there are any errors in the file, the Macro bean will report it in the parse event.
Finally, if you assemble the MacroScreens object yourself, the Macro bean has virtually unlimited extensibility. You can create any action derived from the MacroAction class to suit your needs. You can also do custom screen recognition beyond what the ECLScreenDesc can do by using the ECLSDCustom class contained in the IBM Host Access Class Library.
The following describes a way you would use the Macro bean:
The following illustrates which function calls are allowed in each state:
Disconnected | Stopped | Empty | Playing | Play Paused | Play Error | Recording | Record Paused | Record Error | |
---|---|---|---|---|---|---|---|---|---|
clear | X | X | X | X | X | ||||
setMacro | X | X | X | X | X | ||||
getMacro | X | X | X | X | |||||
play | X | X | X | X | |||||
record | X | X | X | X | X | ||||
pause | X | X | |||||||
stop | X | X | X | X |
The following table lists the properties of the Macro Bean:
Property Name | Type | Default | Access |
---|---|---|---|
macroName | String | zero length string | read/write |
macroDescription | String | zero length string | read/write |
macroAuthor | String | zero length string | read/write |
macroDate | String | zero length string | read/write |
standardTimeout | int | 60000 (mSec) | read/write |
pauseTime | int | 300 (mSec) | read/write |
initialPrompt | boolean | true | read/write |
skipNullPrompts | boolean | false | read/write |
recordUI | boolean | false | read/write |
empty | boolean | true | read |
state | int | STATE_DISCONNECTED | read |
Event Type | Fired To | Event Handler Method |
---|---|---|
MacroPromptEvent - Fired when a macro contains prompt commands/ | Any MacroRuntimeListener | macroPromptEvent(MacroPromptEvent) |
MacroExtractEvent - Fired when a macro contains extract commands/ | Any MacroRuntimeListener | macroExtractEvent(MacroExtractEvent) |
MacroStateEvent - Fired when a macro changes state/ | Any MacroRuntimeListener | macroStateEvent(MacroStateEvent) |
MacroErrorEvent - Fired when a macro error occurs/ | Any MacroRuntimeListener | macroErrorEvent(MacroErrorEvent) |
MacroTraceEvent - Fired when Macro encounters a trace action during play/ | Any MacroRuntimeListener | macroTraceEvent(String) |
MacroMessageEvent - Fired when Macro encounters a message action during play/ | Any MacroRuntimeListener | macroMessageEvent(String) |
MacroCustomActionEvent - Fired when Macro encounters a custom action during play/ | Any MacroCustomActionListener | execute(MacroCustomActionEvent) |
MacroDebugActionEvent - Fired when Macro is about to execute an action during play/ | Any MacroDebugListener | executeAction(MacroDebugActionEvent) |
MacroDebugActionEvent - Fired when Macro has compared a screen during play/ | Any MacroDebugListener | screensCompared(MacroDebugActionEvent) |
MacroParseEvent - Fired when Macro encounters a parse syntax error when setMacro is called/ | Any MacroParseListener | parseFailed(MacroParseEvent) |
PropertyChangeEvent - Fired when a property of the Bean is changed. | Any PropertyChangeListener | propertyChange(PropertyChangeEvent) |
Vetoable PropertyChangeEvent - Fired when a vetoable property of the Bean is changed. | Any VetoableChangeListener | vetoableChange(PropertyChangeEvent) |
MacroExtractCoordEvent - Fired when Macro encounters an extract action during play/ | Any MacroExtractCoordListener | macroExtractCoordEvent(MacroExtractCoordEvent) |
MacroLoopEvent - Fired once for each screen if the screen has a positive recognition limit value/ | Any MacroLoopListener | macroLoopEvent(MacroLoopEvent) |
MacroTickTockEvent - Fired every second until a screen is recongized or the macro times out/ | Any MacroTickTockListener | macroTickTockEvent(MacroTickTockEvent) |
Event Type | Fired From | Event Handler Method |
---|---|---|
CommEvent | Terminal, Session | commEvent(commEvent) |
SendKeyEvent | Terminal, Session | sendKeyEvent(SendKeyEvent) |
Field Summary | |
static java.lang.String |
AUTHOR
Author property keyword. |
static int |
CAPTURE_BOTTOM
Use with the insertScreenDesc method to capture the bottom row(s) of the current screen. |
static int |
CAPTURE_TOP
Use with the insertScreenDesc method to capture the top row(s) of the current screen. |
static java.lang.String |
DATE
Date property keyword. |
static java.lang.String |
DESCRIPTION
Description property keyword. |
static int |
EID_INVALID_PARM
User supplied an invalid parameter |
static int |
EID_M_CONNECTION_DOWN
macro experienced a dropped connected |
static int |
EID_M_INTERNAL_ERR
Macro has encountered an internal error |
static int |
EID_M_INVALID_NS
Invalid next screen |
static int |
EID_M_MISSING_SD
Missing screen descriptor |
static int |
EID_M_RECO_LIMIT_GOTO_NOTFOUND
reco limit reached and the goto screen not found |
static int |
EID_M_RECO_LIMIT_NOGOTO
reco limit reached without a next screen specified |
static int |
EID_M_TIMED_OUT
Macro timed out |
static int |
EID_MACRO_COMMWAIT_FALSE
macro COMMWAIT was false |
static int |
EID_MACRO_PROMPT_ERR
Macro has encountered an prompt error |
static java.lang.String |
EMPTY
Empty property keyword. |
static java.lang.String |
FINAL_SCREEN_BOUNDARY
FinalScreenBoundary property keyword. |
static java.lang.String |
INITIAL_PROMPT
InitialPrompt property keyword. |
static java.lang.String |
INITIAL_SCREEN_BOUNDARY
InitialScreenBoundary property keyword. |
static java.lang.String |
NAME
Name property keyword. |
static java.lang.String |
PAUSE_TIME
PauseTime property keyword. |
static java.lang.String |
RECORD_UI
RecordUI property keyword. |
static java.lang.String |
STANDARD_TIMEOUT
StandardTimeout property keyword. |
static java.lang.String |
STATE
State property keyword. |
static int |
STATE_DISCONNECTED
State property value. |
static int |
STATE_EMPTY
State property value. |
static int |
STATE_INTERNAL_ERROR
State property value. |
static int |
STATE_PLAY_ERROR
State property value. |
static int |
STATE_PLAY_PAUSED
State property value. |
static int |
STATE_PLAYING
State property value. |
static int |
STATE_RECORD_ERROR
State property value. |
static int |
STATE_RECORD_PAUSED
State property value. |
static int |
STATE_RECORDING
State property value. |
static int |
STATE_STOPPED
State property value. |
static int |
STATE_USER_ERROR
State property value. |
Fields inherited from class com.ibm.eNetwork.beans.HOD.HODBean |
BEAN_VERSION_STRING, TRACE_LEVEL, TRACE_MAXIMUM, TRACE_MINIMUM, TRACE_NONE, TRACE_NORMAL |
Fields inherited from interface com.ibm.eNetwork.ECL.ECLConstants |
ALL_FIELDS, ALL_PLANES, ALPHANUM_FIELD, ALTCUR_STR, ALTVIEW_STR, ATTN_STR, ATTR_5250_ALPHA_ONLY, ATTR_5250_ALPHANUM, ATTR_5250_ALPHANUM_MASK, ATTR_5250_BIDI_RTL, ATTR_5250_BRIGHT, ATTR_5250_DBCS_KATAKANA, ATTR_5250_DISPLAY, ATTR_5250_MAG_STRIPE, ATTR_5250_MODIFIED, ATTR_5250_NORMAL, ATTR_5250_NUM_ONLY, ATTR_5250_NUM_PLUS, ATTR_5250_NUM_SHIFT, ATTR_5250_NUM_SIGNED, ATTR_5250_PROTECTED, ATTR_ALPHANUM, ATTR_DISPLAY1, ATTR_DISPLAY2, ATTR_MDT, ATTR_PROTECTED, AUTOPUSH_STR, AUTOREV_STR, BACKSP_STR, BACKTAB_STR, BACKTABWORD_STR, BASE_STR, BEGINFLD_STR, BIDI_MODE_OFF_STR, BIDI_MODE_ON_STR, BIDIL_STR, BLUE_3270, CANCELPJOB_STR, CLEAR_STR, CLEARRECT_STR, CLOSE_STR, COLOR_ATTRIBUTES_PLANE, COLOR_PLANE, COLUMNHEAD_STR, CONTEXT_DISP_STR, CONTINUEPJOB_STR, COPY_STR, COPY_TABLE_STR, COPYALL_STR, COPYAPPEND_STR, CRSEL_STR, CSD_STR, CURDOWN_STR, CURLEFT_STR, CURRIGHT_STR, CURSOR_DIRECTION_STR, CURUP_STR, CUT_STR, DB_CA_EXIST, DB_CLEAR, DB_DB1, DB_DBCS, DB_DBHIGH, DB_DEAD, DB_MIX, DB_SI, DB_SO, DB_SOSI_EXIST, DBATTR_DEFAULT, DBATTR_EITHER, DBATTR_ONLY, DBATTR_OPEN, DBATTR_PURE, DBCS_PLANE, DBCSINP_STR, DBDEFALT, DEF_3270, DELCHAR_STR, DELWORD_STR, DISPLAYABLE_FIELD, DSPSOSI_STR, DUP_CHAR, DUP_STR, EBC_SI, EBC_SO, ENDLINE_STR, ENDPUSH_STR, ENTER_STR, ENTERRESET_STR, ERASEEOF_STR, ERASEFLD_STR, ERASEINPUT_STR, EXFIELD_PLANE, EXT_ATTR_3270_APL, EXT_ATTR_3270_BLINK, EXT_ATTR_3270_CHAR, EXT_ATTR_3270_DBCS, EXT_ATTR_3270_EBCDIC, EXT_ATTR_3270_REVERSE, EXT_ATTR_3270_UNDERLINE, EXT_ATTR_5250_BLINK, EXT_ATTR_5250_COLUMN_SEP, EXT_ATTR_5250_REVERSE, EXT_ATTR_5250_UNDERLINE, EXT_BLINK, EXT_COL_SEP, EXT_D_BOTH, EXT_D_LEFT, EXT_D_OVER, EXT_D_RIGHT, EXT_D_UNDER, EXT_DBCS, EXT_EFA_APL_SET, EXT_EFA_FG_SET, EXT_G_ALL, EXT_G_LEFT, EXT_G_OVER, EXT_G_RIGHT, EXT_G_UNDER, EXT_LINEATTR_CHECK, EXT_LINEATTR_DBLWID, EXT_LINEATTR_DBLWID_DBLHT_BOT, EXT_LINEATTR_DBLWID_DBLHT_TOP, EXT_LINEATTR_NORMAL, EXT_NON_ERASEABLE, EXT_NORMAL, EXT_OPAQUE, EXT_REVERSE, EXT_UNDERLN, F1_STR, F10_STR, F11_STR, F12_STR, F13_STR, F14_STR, F15_STR, F16_STR, F17_STR, F18_STR, F19_STR, F2_STR, F20_STR, F21_STR, F22_STR, F23_STR, F24_STR, F3_STR, F4_STR, F5_STR, F6_STR, F7_STR, F8_STR, F9_STR, FIELD_MARK, FIELD_PLANE, FINAL_STR, FLDBASE_STR, FLDEXT_STR, FLDMINUS_STR, FLDMRK_STR, FLDPLUS_STR, FLDREV_STR, FLDSHAPE_STR, FORMFEED_STR, FWDTAB_STR, GRCURSOR_STR, GREEN_3270, GRID_PLANE, HELP_STR, HILIGHT_FIELD, HINDIL_STR, HOME_STR, HOST_PLANE, HOSTPRT_STR, INITIAL_STR, INSERT_STR, ISOLATED_STR, JUMP_STR, KEYPAD0_STR, KEYPAD1_STR, KEYPAD2_STR, KEYPAD3_STR, KEYPAD4_STR, KEYPAD5_STR, KEYPAD6_STR, KEYPAD7_STR, KEYPAD8_STR, KEYPAD9_STR, KEYPADCOMMA_STR, KEYPADDOT_STR, KEYPADENTER_STR, KEYPADMINUS_STR, LATINL_STR, LOGICAL_DISP_STR, LOLIGHT_FIELD, MARKDOWN_STR, MARKLEFT_STR, MARKRIGHT_STR, MARKUP_STR, MIDDLE_STR, MODIFIED_FIELD, MOVEDOWN_STR, MOVELEFT_STR, MOVERIGHT_STR, MOVEUP_STR, MSR_STR, NATIONAL_DISP_STR, NEUT_3270, NEWLINE_STR, NEXTWORD_STR, NLS_PLANE, NO_TIMEOUT, NOMINAL_DISP_STR, NON_DISPLAYABLE_FIELD, NON_PENDETECTABLE_FIELD, NUMCONTEXT_STR, NUMERIC_FIELD, NUMNATIONAL_STR, NUMNOMINAL_STR, OICR_STR, PA1_STR, PA2_STR, PA3_STR, PAGEDWN_STR, PAGEUP_STR, PASTE_STR, PASTENEXT_STR, PENDETECTABLE_FIELD, PINK_3270, PREVIOUSWORD_STR, PRINT_STR, PROTECTED_FIELD, PRTESTPAGE_STR, PUSH_STR, RAWTEXT_PLANE, RED_3270, RESET_STR, RETRYPRT_STR, ROUNDTRIP_OFF_STR, ROUNDTRIP_ON_STR, RULE_STR, SCREENREV_STR, SEARCH_BACKWARD, SEARCH_FORWARD, SELECTALL_STR, SHIFT_F1_STR, SHIFT_F10_STR, SHIFT_F11_STR, SHIFT_F12_STR, SHIFT_F13_STR, SHIFT_F14_STR, SHIFT_F15_STR, SHIFT_F16_STR, SHIFT_F17_STR, SHIFT_F18_STR, SHIFT_F19_STR, SHIFT_F2_STR, SHIFT_F20_STR, SHIFT_F3_STR, SHIFT_F4_STR, SHIFT_F5_STR, SHIFT_F6_STR, SHIFT_F7_STR, SHIFT_F8_STR, SHIFT_F9_STR, SMARTORDERING_OFF_STR, SMARTORDERING_ON_STR, STARTMAC_STR, SYSREQ_STR, TABWORD_STR, TEST_STR, TEXT_PLANE, THAIL_STR, TOGGLEHEB_STR, TURQ_3270, TXTORL2R_STR, TXTORR2L_STR, TXTTYPEL_STR, TXTTYPEV_STR, UNMARK_STR, UNMODIFIED_FIELD, UNPROTECTED_FIELD, VISUAL_DISP_STR, VTPRINTCONVERT_STR, WORDLFT_STR, WORDRGT_STR, YELLOW_3270 |
Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants |
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT |
Constructor Summary | |
Macro()
Macro Bean null constructor. |
|
Macro(java.util.Properties p)
Constructor which takes a Properties object containing the initial property settings. |
Method Summary | |
void |
addMacroCustomActionListener(MacroCustomActionListener listener)
Adds the given MacroCustomActionListener to the macro. |
void |
addMacroDebugListener(MacroDebugListener listener)
Adds the given MacroDebugListener to the macro. |
void |
addMacroExtractCoordListener(MacroExtractCoordListener listener)
Adds the given MacroExtractCoordListener to the macro. |
void |
addMacroLoopListener(MacroLoopListener listener)
Adds the given MacroLoopListener to the macro. |
void |
addMacroParseListener(MacroParseListener listener)
Adds the given MacroParseListener to the macro. |
void |
addMacroRuntimeListener(MacroRuntimeListener listener)
Adds the given MacroRuntimeListener to the macro. |
void |
addMacroTickTockListener(MacroTickTockListener listener)
Adds the given MacroTickTockListener to the macro. |
void |
beginScreen(java.lang.String name,
int recoLimit,
boolean startScreen,
boolean stopScreen)
Deprecated. |
void |
clear()
Clears the current macro from the Macro bean. |
java.lang.Object |
clone()
Returns a new instance of Macro with the same properties as the current Macro. |
void |
dispose()
Cleans up Macro's base environment and working storage. |
void |
endScreen()
Deprecated. |
java.lang.String |
getMacro()
Returns the current macro to a String. |
void |
getMacro(java.io.OutputStream strm)
Returns the current macro to an output stream. |
void |
getMacro(java.io.PrintWriter wrtr)
Returns the current macro to a PrintWriter. |
java.lang.String[] |
getMacroArray()
Returns the current macro to a string array. |
java.lang.String |
getMacroAuthor()
Returns the author of the macro. |
java.lang.String |
getMacroDate()
Returns the date of the macro. |
java.lang.String |
getMacroDescription()
Returns the description of the macro. |
MacroIOProvider |
getMacroIOProvider()
returns MacroIOProvider associated with this macro |
java.lang.String |
getMacroName()
Returns the name of the macro. |
MacroScreens |
getParsedMacro()
Returns the current macro as a MacroScreens object. |
int |
getPauseTime()
Returns the pause value for the macro. |
int |
getPSEventType()
Returns the type of Presentation Space (PS) event that the Macro bean monitors for screen matching. |
int |
getStandardTimeout()
Returns the standard timeout value for the macro. |
int |
getState()
Returns current state of the currently playing/active Macro Bean. |
void |
insertConnectionWait(int waitType,
int timeOut)
Deprecated. |
void |
insertCustomAction(java.lang.String argID,
java.lang.String argsArgs)
Inserts a custom action into the current macro screen during recording. |
void |
insertDataExtract(java.lang.String name,
int srow,
int scol,
int erow,
int ecol)
Method that inserts a data extract sequence into the macro string. |
void |
insertDataExtract(java.lang.String name,
int srow,
int scol,
int erow,
int ecol,
java.lang.String planes)
Method that inserts a data extract sequence into the macro string. |
void |
insertInput(java.lang.String text,
boolean xlateAid,
boolean moveCursor)
Inserts an input action into the current macro screen during recording. |
void |
insertInput(java.lang.String text,
int row,
int col,
boolean xlateAid,
boolean moveCursor)
Inserts an input action into the current macro screen during recording. |
void |
insertMessage(java.lang.String msg,
java.lang.String title)
Inserts a message action into the current macro screen during recording. |
void |
insertOIAWait()
Deprecated. |
void |
insertPause(long argTimeout)
Inserts a pause action into the current macro screen during recording. |
void |
insertPlayMacro(java.lang.String argMacName,
java.lang.String argScrName,
java.lang.String argXferVarType)
Inserts a play macro action into the current macro screen during recording. |
void |
insertPrompt(int row,
int col,
int len,
java.lang.String name,
java.lang.String value,
boolean clearField)
Inserts a user prompt sequence into the current macro. |
void |
insertPrompt(int row,
int col,
int len,
java.lang.String name,
java.lang.String value,
boolean clearField,
boolean encrypted,
boolean placeValue)
Inserts a password user prompt sequence into the current macro. |
void |
insertPrompt(java.lang.String row,
java.lang.String col,
java.lang.String len,
java.lang.String name,
java.lang.String value,
boolean clearField)
Deprecated. |
void |
insertPrompt(java.lang.String row,
java.lang.String col,
java.lang.String len,
java.lang.String name,
java.lang.String value,
boolean clearField,
java.lang.String echoChar)
Deprecated. |
void |
insertRunProgram(java.lang.String prog,
java.lang.String param,
boolean wait)
Inserts a run program action into the current macro screen during recording. |
void |
insertScreenDesc(boolean useOIA,
boolean useCursor,
boolean useFields,
boolean useInputFields)
Inserts new screen description elements into the current macro screen. |
void |
insertScreenDesc(boolean useNumFields,
boolean useNumInputFields,
java.lang.String keyword,
java.lang.String timeOut)
Deprecated. |
void |
insertScreenDesc(int textOrient,
int inset)
Inserts a new screen string description element into the current macro screen. |
void |
insertScreenDesc(int srow,
int scol,
int erow,
int ecol)
Inserts a screen string description element into the current macro screen. |
void |
insertSDAttrib(char attrib,
int row,
int col,
int plane,
boolean opt,
boolean invertReco)
Inserts an attribute description element into the current screen based on the given parameters. |
void |
insertSDBlock(java.lang.String[] text,
int row,
int col,
boolean caseSense,
boolean opt,
boolean invertReco)
Inserts a block description element into the current screen based on the given parameters. |
void |
insertSDBlock(java.lang.String[] text,
int srow,
int scol,
int erow,
int ecol,
boolean caseSense,
boolean opt,
boolean invertReco)
Inserts a block description element into the current screen based on the given parameters. |
void |
insertSDCursor(int row,
int col,
boolean opt,
boolean invertReco)
Inserts a cursor position description element into the current screen based on the given parameters. |
void |
insertSDCustom(com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener listener,
java.lang.String id,
boolean opt)
Inserts a custom description element into the current screen based on the given parameters. |
void |
insertSDFields(int num,
boolean opt,
boolean invertReco)
Inserts a field count description element into the current screen based on the given parameters. |
void |
insertSDInputFields(int num,
boolean opt,
boolean invertReco)
Inserts an input field count description element into the current screen based on the given parameters. |
void |
insertSDOIA(int oiatype,
boolean opt,
boolean invertReco)
Inserts an OIA status description element into the current screen based on the given parameters. |
void |
insertSDString(java.lang.String text,
int row,
int col,
boolean caseSense,
boolean opt,
boolean invertReco)
Inserts a string description element into the current screen based on the given parameters. |
void |
insertSDString(java.lang.String text,
int srow,
int scol,
int erow,
int ecol,
boolean caseSense,
boolean opt,
boolean invertReco)
Inserts a string description element into the current screen based on the given parameters. |
void |
insertTrace(java.lang.String data,
int type)
Inserts a trace action into the current macro screen during recording. |
void |
insertXfer(int argDirection,
java.lang.String argHostFile,
java.lang.String argPCFile,
java.lang.String argOptions,
boolean argClear,
int argTimeout,
java.lang.String argPCCodePage,
java.lang.String argHostOrient,
java.lang.String argPCOrient,
java.lang.String argPCFType,
java.lang.String argLamAlefExpan,
java.lang.String argLamAlefComp)
Deprecated. |
void |
insertXfer(int argDirection,
java.lang.String argHostFile,
java.lang.String argPCFile,
java.lang.String argOptions,
boolean argClear,
int argTimeout,
java.lang.String argPCCodePage,
java.lang.String argHostOrient,
java.lang.String argPCOrient,
java.lang.String argPCFType,
java.lang.String argLamAlefExpan,
java.lang.String argLamAlefComp,
java.lang.String argSymSwap,
java.lang.String argNumerals,
java.lang.String argRoundTrip)
Inserts a file transfer action into the current macro screen during recording. |
boolean |
isEmpty()
Returns a flag that indicates if a macro is currently loaded. |
boolean |
isFinalScreenBoundary()
Deprecated. |
boolean |
isInitialPrompt()
Returns the flag that controls whether Macro prescans for prompts. |
boolean |
isInitialScreenBoundary()
Deprecated. |
boolean |
isRecordUI()
Returns whether the Macro will record user interface events on the Terminal bean. |
boolean |
isSkipNullPrompts()
Returns whether the Macro will skip prompt action that don't have values instead of stopping and firing and error event. |
void |
linkScreens(java.lang.String screenName,
java.lang.String nextScreenName)
Links valid MacroNextScreens to a given Screen in the macro. |
void |
linkScreens(java.lang.String screenName,
java.lang.String nextScreenName,
int timeout)
Links valid MacroNextScreens to a given Screen in the macro. |
void |
pause()
Pauses recording or playing the macro. |
void |
play()
Plays the current macro. |
void |
play(java.lang.String screenName)
Plays the current macro starting with the given screen. |
void |
play(java.lang.String screenName,
int actionIndex)
Plays the current macro starting with the given screen and action. |
void |
record()
Starts recording a macro, or resumes recording if the Macro is in STATE_RECORD_PAUSED. |
void |
record(boolean append)
Starts recording a macro, or resumes recording if the Macro is in STATE_RECORD_PAUSED. |
void |
removeMacroCustomActionListener(MacroCustomActionListener listener)
Removes the given MacroCustomActionListener from the macro. |
void |
removeMacroDebugListener(MacroDebugListener listener)
Removes the given MacroDebugListener from the macro. |
void |
removeMacroExtractCoordListener(MacroExtractCoordListener listener)
Removes the given MacroExtractCoordListener from the macro. |
void |
removeMacroLoopListener(MacroLoopListener listener)
Removes the given MacroLoopListener from the macro. |
void |
removeMacroParseListener(MacroParseListener listener)
Removes the given MacroParseListener from the macro. |
void |
removeMacroRuntimeListener(MacroRuntimeListener listener)
Removes the given MacroRuntimeListener from the macro. |
void |
removeMacroTickTockListener(MacroTickTockListener listener)
Removes the given MacroTickTockListener from the macro. |
void |
setCurrentScreenName(java.lang.String name)
Sets the name of the current screen during recording. |
void |
setCurrentScreenTransient(boolean val)
Sets the current screen in recording to transient. |
void |
setCurrentStartScreen(boolean val)
Deprecated. |
void |
setCurrentStopScreen(boolean val)
Deprecated. |
void |
setCustomRecoListener(com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener listener,
java.lang.String id)
Registers a custom recognition listener with a given ID. |
void |
setFinalScreenBoundary(boolean flag)
Deprecated. |
void |
setInitialPrompt(boolean flag)
Sets the flag that controls whether Macro prescans for prompts. |
void |
setInitialScreenBoundary(boolean flag)
Deprecated. |
void |
setMacro(java.io.BufferedReader macReader)
Sets the current macro from a buffered reader. |
void |
setMacro(java.io.InputStream strm)
Sets the current macro from an input stream. |
void |
setMacro(java.lang.String str)
Sets the current macro from a string. |
void |
setMacroArray(java.lang.String[] strArray)
Sets the current macro from a string array. |
void |
setMacroAuthor(java.lang.String author)
Sets the author of the macro. |
void |
setMacroDate(java.lang.String date)
Sets the creation date of the macro. |
void |
setMacroDescription(java.lang.String desc)
Sets the description of the macro. |
void |
setMacroIOProvider(MacroIOProvider macIO)
Sets MacroIOProvider. |
void |
setMacroName(java.lang.String name)
Sets the name of the macro. |
void |
setParsedMacro(MacroScreens argMS)
Sets the current macro from a MacroScreens object. |
void |
setPauseTime(int wt)
Sets the pause value for the macro. |
void |
setPrompts(MacroPrompts p)
Sets the prompts after a MacroPromptEvent has been handled. |
void |
setPSEventType(int val)
Sets the type of Presentation Space (PS) event that the Macro bean monitors for screen matching. |
void |
setRecordUI(boolean newVal)
Sets whether the Macro will record user interface events on the Terminal bean. |
void |
setScreenTimeout(int timeout)
Sets the timeout value for any next screens specified in the current screen. |
void |
setScreenTimeout(java.lang.String name,
int timeout)
Sets the timeout value for any next screens specified in the screen with the given name. |
void |
setSkipNullPrompts(boolean argSkip)
Sets whether the Macro will skip prompt action that don't have values instead of stopping and firing and error event. |
void |
setStandardTimeout(int wt)
Sets the standard timeout value for the macro. |
void |
setUnrecordedText(java.lang.String text)
Puts text into the presentation space during recording without recording the keystrokes. |
void |
setUnrecordedText(java.lang.String text,
int row,
int col)
Puts text into the presentation space during recording without recording the keystrokes. |
void |
stop()
Stops recording or playing the macro. |
java.lang.String |
toString()
Returns the current macro as a string. |
Methods inherited from class com.ibm.eNetwork.beans.HOD.HODBean |
addPropertyChangeListener, addTraceListener, addVetoableChangeListener, getComponent, getFunction, getProperties, getTraceLevel, getTraceName, propertyChange, readExternal, removePropertyChangeListener, removeTraceListener, removeVetoableChangeListener, setProperties, setTraceLevel, writeExternal |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.SendKeyListener |
sendKeys |
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.CommListener |
CommEvent |
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.ScreenMouseListener |
mouseEvent |
Field Detail |
public static final java.lang.String NAME
public static final java.lang.String DESCRIPTION
public static final java.lang.String AUTHOR
public static final java.lang.String DATE
public static final java.lang.String STANDARD_TIMEOUT
public static final java.lang.String PAUSE_TIME
public static final java.lang.String INITIAL_PROMPT
public static final java.lang.String RECORD_UI
public static final java.lang.String STATE
public static final java.lang.String INITIAL_SCREEN_BOUNDARY
public static final java.lang.String FINAL_SCREEN_BOUNDARY
public static final java.lang.String EMPTY
public static final int STATE_STOPPED
public static final int STATE_PLAYING
public static final int STATE_RECORDING
public static final int STATE_PLAY_PAUSED
public static final int STATE_RECORD_PAUSED
public static final int STATE_EMPTY
public static final int STATE_DISCONNECTED
public static final int STATE_PLAY_ERROR
public static final int STATE_RECORD_ERROR
public static final int STATE_INTERNAL_ERROR
public static final int STATE_USER_ERROR
public static final int CAPTURE_TOP
insertScreenDesc(int, int)
public static final int CAPTURE_BOTTOM
insertScreenDesc(int, int)
public static final int EID_M_INTERNAL_ERR
public static final int EID_INVALID_PARM
public static final int EID_M_MISSING_SD
public static final int EID_M_INVALID_NS
public static final int EID_M_TIMED_OUT
public static final int EID_M_RECO_LIMIT_NOGOTO
public static final int EID_M_RECO_LIMIT_GOTO_NOTFOUND
public static final int EID_MACRO_COMMWAIT_FALSE
public static final int EID_MACRO_PROMPT_ERR
public static final int EID_M_CONNECTION_DOWN
Constructor Detail |
public Macro()
public Macro(java.util.Properties p) throws java.beans.PropertyVetoException
p
- the new Properties for the Macro Bean.java.beans.PropertyVetoException
- Fired if an invalid property value
is given.Method Detail |
public void dispose()
dispose
in class HODBean
public void setUnrecordedText(java.lang.String text, int row, int col) throws MacroException
Virtual row/column positioning is legal with this method. That is, it is allowable to pass negative numbers in the row and col parameters. If values are negative, the text will be placed appropriately from the bottom of the screen (example, row = -2, places the text on the 2nd to the last row on the screen). Negative numbers greater than the screen size will wrap back to the bottom.
text
- Text to be written to the PSrow
- Row where text is to be written. Passing 0 will cause an exception.col
- Column where text is to be written. Passing 0 will cause an exception.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setUnrecordedText(java.lang.String text) throws MacroException
text
- Text to be written to the PSMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setCustomRecoListener(com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener listener, java.lang.String id) throws MacroException
listener
- listener that is called for recognitionid
- unique identifier for recognitionMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
public void addMacroRuntimeListener(MacroRuntimeListener listener) throws MacroException
listener
- The MacroRuntimeListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroRuntimeListener(com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener)
public void removeMacroRuntimeListener(MacroRuntimeListener listener) throws MacroException
listener
- The MacroRuntimeListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroRuntimeListener(com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener)
public void addMacroTickTockListener(MacroTickTockListener listener) throws MacroException
listener
- The MacroTickTockListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroTickTockListener(com.ibm.eNetwork.beans.HOD.event.MacroTickTockListener)
public void removeMacroTickTockListener(MacroTickTockListener listener) throws MacroException
listener
- The MacroTickTockListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroTickTockListener(com.ibm.eNetwork.beans.HOD.event.MacroTickTockListener)
public void addMacroExtractCoordListener(MacroExtractCoordListener listener) throws MacroException
listener
- The MacroExtractCoordListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroExtractCoordListener(com.ibm.eNetwork.beans.HOD.event.MacroExtractCoordListener)
public void removeMacroExtractCoordListener(MacroExtractCoordListener listener) throws MacroException
listener
- The MacroExtractCoordListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroExtractCoordListener(com.ibm.eNetwork.beans.HOD.event.MacroExtractCoordListener)
public void addMacroLoopListener(MacroLoopListener listener) throws MacroException
listener
- The MacroLoopListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroLoopListener(com.ibm.eNetwork.beans.HOD.event.MacroLoopListener)
public void removeMacroLoopListener(MacroLoopListener listener) throws MacroException
listener
- The MacroLoopListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroLoopListener(com.ibm.eNetwork.beans.HOD.event.MacroLoopListener)
public void addMacroParseListener(MacroParseListener listener) throws MacroException
listener
- The MacroParseListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroParseListener(com.ibm.eNetwork.beans.HOD.event.MacroParseListener)
public void removeMacroParseListener(MacroParseListener listener) throws MacroException
listener
- The MacroParseListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroParseListener(com.ibm.eNetwork.beans.HOD.event.MacroParseListener)
public void addMacroCustomActionListener(MacroCustomActionListener listener) throws MacroException
listener
- The MacroCustomActionListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroCustomActionListener(com.ibm.eNetwork.beans.HOD.event.MacroCustomActionListener)
public void removeMacroCustomActionListener(MacroCustomActionListener listener) throws MacroException
listener
- The MacroCustomActionListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroCustomActionListener(com.ibm.eNetwork.beans.HOD.event.MacroCustomActionListener)
public void addMacroDebugListener(MacroDebugListener listener) throws MacroException
listener
- The MacroDebugListener to be addedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.removeMacroDebugListener(com.ibm.eNetwork.beans.HOD.event.MacroDebugListener)
public void removeMacroDebugListener(MacroDebugListener listener) throws MacroException
listener
- The MacroDebugListener to be removedMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.addMacroDebugListener(com.ibm.eNetwork.beans.HOD.event.MacroDebugListener)
public void setMacroName(java.lang.String name) throws java.beans.PropertyVetoException
Name
- String containing the new name for the macro.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.public java.lang.String getMacroName()
public void setMacroDescription(java.lang.String desc) throws java.beans.PropertyVetoException
desc
- String containing the new description of the macro.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.public java.lang.String getMacroDescription()
public void setMacroAuthor(java.lang.String author) throws java.beans.PropertyVetoException
author
- String containing the new author of the macro.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.public java.lang.String getMacroAuthor()
public void setMacroDate(java.lang.String date) throws java.beans.PropertyVetoException
date
- String containing the new date of the macro.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.public java.lang.String getMacroDate()
public void setInitialPrompt(boolean flag) throws java.beans.PropertyVetoException
Prompt
- If true, generates one prompt event during prescan. If false,
generates prompt events for each prompt in the macro.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.isInitialPrompt()
public boolean isInitialPrompt()
setInitialPrompt(boolean)
public void setSkipNullPrompts(boolean argSkip)
argSkip
- if true, the null prompt values will be ignoredpublic boolean isSkipNullPrompts()
public void setPSEventType(int val)
User events are generated by user actions like typing or moving the mouse. Host events are generated by the host system sending data to the Terminal or Session bean.
The default is ECLPS.HOST_EVENTS
getPSEventType()
public int getPSEventType()
setPSEventType(int)
public void setRecordUI(boolean newVal) throws java.beans.PropertyVetoException
Note: if this property is set to true, cursor position will not be automatically recorded in the screen descriptions. This happens because the Macro bean is unable to reliably determine the place of the cursor when mouse clicks move the cursor.
newVal
- if true, UI events will be recorded.java.beans.PropertyVetoException
- Thrown if one of the
VetoableChangeListeners rejects the change.public boolean isRecordUI()
public boolean isEmpty()
getState()
public void setStandardTimeout(int wt) throws java.beans.PropertyVetoException
Timeout
- Timeout value in milliseconds.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.getStandardTimeout()
public int getStandardTimeout()
setStandardTimeout(int)
public void setPauseTime(int wt) throws java.beans.PropertyVetoException
Time
- Delay time in milliseconds.java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.getPauseTime()
public int getPauseTime()
setPauseTime(int)
public int getState()
public boolean isInitialScreenBoundary()
setInitialScreenBoundary(boolean)
public void setInitialScreenBoundary(boolean flag) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.isInitialScreenBoundary()
public boolean isFinalScreenBoundary()
setFinalScreenBoundary(boolean)
public void setFinalScreenBoundary(boolean flag) throws java.beans.PropertyVetoException
java.beans.PropertyVetoException
- Thrown if an invalid property value
is given.isFinalScreenBoundary()
public java.lang.String toString()
toString
in class HODBean
public java.lang.Object clone()
clone
in class HODBean
public void clear()
public void stop()
public void record()
Note: when record is called, a new screen will be created automatically. The name for this screen will be generated automatically also. If you wish to change the name of the screen, just call beginScreen with the new name and the automatically generated screen will be discarded.
record()
public void record(boolean append)
Note: when record is called, a new screen will be created automatically. The name for this screen will be generated automatically also. If you wish to change the name of the screen, just call beginScreen with the new name and the automatically generated screen will be discarded.
append
- if true, macro will not be clearedrecord()
public void pause()
public void play(java.lang.String screenName) throws MacroException
java.lang.String
- screenName name of MacroScreen object to start playing withMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void play(java.lang.String screenName, int actionIndex) throws MacroException
java.lang.String
- screenName name of MacroScreen object to start playing withMacroAction
- actionIndex index of MacroAction object to start playing withMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void play()
public void insertScreenDesc(boolean useNumFields, boolean useNumInputFields, java.lang.String keyword, java.lang.String timeOut) throws MacroException
Warning: this will clear all the descriptors in the current screen added by any Macro.insertSD* calls.
useNumFields
- Use the number of fields in the PS to describe
the screen.useNumInputFields
- Use the number of input fields in the PS to
describe the screen.keyword
- Use a keyword to describe the screen. Pass null
if you don't want to use a keyword.timeOut
- Time out value for wait. Pass 0 for indefinite wait.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertScreenDesc(boolean, boolean, boolean, boolean)
,
insertScreenDesc(int, int)
,
insertScreenDesc(int, int, int, int)
public void insertOIAWait()
public void insertConnectionWait(int waitType, int timeOut)
waitType
- type of connection event to wait for. These types
are defined in ECLConnection (example, ECLConnection.CONNECTION_INIT),
and are mutually exclusive for the method. That is, you
may not OR values together.timeOut
- Time out value for wait. Pass 0 for indefinite wait.
public void beginScreen(java.lang.String name, int recoLimit, boolean startScreen, boolean stopScreen) throws MacroException
name
- name for the screen to addrecolimit
- recognition limit for the screen (0 if no limit). See
macro syntax guide for details.startScreen
- if true, this screen is the initial screen for the macro.stopScreen
- if true, this screen is one of the final screens for the macro.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.endScreen()
public void setCurrentScreenTransient(boolean val) throws MacroException
val
- if true, screen will be set to transientMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setCurrentStartScreen(boolean val) throws MacroException
val
- if true, screen will be a start screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setCurrentStopScreen(boolean val) throws MacroException
val
- if true, screen will be a stop screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setCurrentScreenName(java.lang.String name) throws MacroException
name
- new name for the screen within the macro.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void endScreen()
beginScreen(java.lang.String, int, boolean, boolean)
public void insertScreenDesc(boolean useOIA, boolean useCursor, boolean useFields, boolean useInputFields)
Warning: this will clear all the descriptors in the current screen added by any Macro.insertSD* calls.
useOIA
- If true, OIA state must be uninhibited for screen to matchuseCursor
- If true, current cursor position will be captureduseNumFields
- If true, current total field count will be captureduseNumInputFields
- If true, current input field count will be capturedpublic void insertScreenDesc(int textOrient, int inset)
Warning: this will clear all the descriptors in the current screen added by any Macro.insertSD* calls.
textOrient
- orientation to capture the screen textinset
- number of rows from top or bottom to captureCAPTURE_TOP
,
CAPTURE_BOTTOM
public void insertScreenDesc(int srow, int scol, int erow, int ecol) throws MacroException
srow
- upper left rowscol
- upper left columnerow
- lower right rowecol
- lower right columnMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertSDString(java.lang.String text, int row, int col, boolean caseSense, boolean opt, boolean invertReco) throws MacroException
This version of insertSDString inserts a string description element that must appear at the exact row/column position given.
Note: if macro is not recording, this method will not insert a description element.
text
- string that must appear on the screenrow
- starting row positioncol
- ending column positioncaseSense
- if true, string comparison is case sensitiveopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertSDString(java.lang.String, int, int, int, int, boolean, boolean, boolean)
public void insertSDString(java.lang.String text, int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt, boolean invertReco) throws MacroException
This version of insertSDString inserts a string description element that must appear in the rectangle specified by the given parameters. Wrapping is not allowed.
Note: if macro is not recording, this method will not insert a description element.
text
- string that must appear on the screensrow
- upper left rowscol
- upper left columnerow
- lower right rowecol
- lower right columncaseSense
- if true, string comparison is case sensitiveopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertSDString(java.lang.String, int, int, boolean, boolean, boolean)
public void insertSDBlock(java.lang.String[] text, int row, int col, boolean caseSense, boolean opt, boolean invertReco) throws MacroException
This version of insertSDBlock inserts a string description element that must appear at the exact row/column position given.
Note: if macro is not recording, this method will not insert a description element.
text
- strings that must appear on the screenrow
- starting row positioncol
- ending column positioncaseSense
- if true, string comparison is case sensitiveopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertSDBlock(java.lang.String[], int, int, boolean, boolean, boolean)
public void insertSDBlock(java.lang.String[] text, int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt, boolean invertReco) throws MacroException
This version of insertSDBlock inserts a string description element that must appear in the rectangle specified by the given parameters. Wrapping is not allowed.
Note: if macro is not recording, this method will not insert a description element.
text
- string that must appear on the screensrow
- upper left rowscol
- upper left columnerow
- lower right rowecol
- lower right columncaseSesnse
- if true, string comparison is case sensitiveopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertSDBlock(java.lang.String[], int, int, boolean, boolean, boolean)
public void insertSDOIA(int oiatype, boolean opt, boolean invertReco) throws MacroException
Using this method will cause the screen recognition system to monitor the host Operator Information Area (OIA) for the given status. Currently, the only two valid options are ECLSDOIA.OIA_INPUTINHIBITED, which will match only if it is possible to type on the host screen, and ECLSDOIA.OIA_DONTCARE, which ignores the OIA altogether. The default is to monitor for input not inhibited. To turn OIA monitoring off, call this method with the don't care setting.
Note: if macro is not recording, this method will not insert a description element.
oiatype
- type of OIA status to wait for, must be ECLSDOIA.OIA_INPUTINHIBITED
or ECLSDOIA.OIA_DONTCARE.opt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertSDCursor(int row, int col, boolean opt, boolean invertReco)
Using this method will cause the screen recognition system to match the cursor position on the host screen to the given parameters.
Note: if macro is not recording, this method will not insert a description element.
row
- cursor row positioncol
- cursor column positionopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.public void insertSDAttrib(char attrib, int row, int col, int plane, boolean opt, boolean invertReco) throws MacroException
Using this method will cause the screen recognition system to match the given attribute value against the attribute on the host screen. This is an advanced feature and should only be used if you are having trouble making a screen description truly unique. The attribute value must be one of the values specified in the IBM WebSphere Host Access Class Library (HACL) field attribute table in the reference appendix.
Note: if macro is not recording, this method will not insert a description element.
attrib
- attribute value that must appear on the screenrow
- starting row positioncol
- ending column positionplane
- plane to search in, must be ECLConstants.FIELD_PLANE,
ECLConstants.EXFIELD_PLANE, or ECLConstants.COLOR_PLANEopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertSDFields(int num, boolean opt, boolean invertReco)
Using this method will cause the screen recognition system to match the total number of host screen fields to the value given.
Note: if macro is not recording, this method will not insert a description element.
num
- field count to matchopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.public void insertSDInputFields(int num, boolean opt, boolean invertReco)
Using this method will cause the screen recognition system to match the number of host screen input fields to the value given.
Note: if macro is not recording, this method will not insert a description element.
num
- field count to matchopt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.invertReco
- if true, recognition of the element will be inverted. This
introduced a pseudo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.public void insertSDCustom(com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener listener, java.lang.String id, boolean opt) throws MacroException
Note: if macro is not recording, this method will not insert a description element.
listener
- object that implements the ECLCustomRecoListener interface.
this object will be called with the ID parameter, whereby
it should look at the host screen and determine a match by
its own criteria. If there is a match, the object should
return true.id
- identifier string used to differentiate between multiple
custom recognition elements in a screen(s).opt
- if true, element is optional. Optional elements introduce
a pseudo-boolean OR capability. The recognition system
will first compare all non-optional elements, which must
all match. If the non-optional matches are successful,
optional elements don't need to be considered. If there
are no non-optional elements in a screen, at least one
optional element must match.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
public void insertInput(java.lang.String text, boolean xlateAid, boolean moveCursor) throws MacroException
This version of insertInput places the text at the current cursor position.
Note: if macro is not recording, this method will not insert an action.
text
- text to place on the host screen.xlateAid
- if true, host action keys embedded in the text parameter
will be translated. See ECLConstants class for host action
key values. For example, if xlateAid is False, the string "logon[enter]", is sent directly to the host session without being translated.moveCursor
- if true, cursor will move past the last character of the
text placed on the screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertInput(java.lang.String text, int row, int col, boolean xlateAid, boolean moveCursor) throws MacroException
This version of insertInput places the text at the given cursor position.
Note: if macro is not recording, this method will not insert an action.
text
- text to place on the host screen.row
- row position to place the textcol
- column position to place the textxlateAid
- if true, host action keys embedded in the text parameter
will be translated. See ECLConstants class for host action
key values. Example, "logon[enter]", where [enter] is the
host action key.moveCursor
- if true, cursor will move past the last character of the
text placed on the screen.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertMessage(java.lang.String msg, java.lang.String title) throws MacroException
Note: if macro is not recording, this method will not insert an action.
msg
- actual text of the message to send to the usertitle
- title of the messageMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertTrace(java.lang.String data, int type) throws MacroException
Note: if macro is not recording, this method will not insert an action.
data
- text of the tracetype
- sets where the trace data will go. Must be MacroActionTrace.TRACE_BEANS,
MacroActionTrace.TRACE_USER, or MacroActionTrace.TRACE_SYSOUT.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertCustomAction(java.lang.String argID, java.lang.String argsArgs) throws MacroException
Note: if macro is not recording, this method will not insert an action.
argID
- identifier string used to differentiate between multiple
custom action elements in a screen(s).argArgs
- arguments to pass to the custom action listener.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void insertPrompt(java.lang.String row, java.lang.String col, java.lang.String len, java.lang.String name, java.lang.String value, boolean clearField) throws MacroException
Note: if macro is not recording, this method will not insert an action.
row
- Row in Presentation Space to place promptcol
- Column in Presentation Space to place promptlen
- Length of prompt. Use this to guard against skip fields.name
- Identifier of prompt. Multiple instances of the same
identifier may appear in a macro.value
- Default value to use for this prompt line only. This
value will be overridden by the value returned in the
setPrompts call.clearField
- Clears the field that the prompt is placed in if true.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
insertPrompt(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String)
,
setPrompts(com.ibm.eNetwork.beans.HOD.MacroPrompts)
public void insertPrompt(java.lang.String row, java.lang.String col, java.lang.String len, java.lang.String name, java.lang.String value, boolean clearField, java.lang.String echoChar) throws MacroException
Note: if macro is not recording, this method will not insert an action.
row
- Row in Presentation Space to place promptcol
- Column in Presentation Space to place promptlen
- Length of prompt. Use this to guard against skip fields.name
- Identifier of prompt. Multiple instances of the same
identifier may appear in a macro.value
- Default value to use for this prompt line only. This
value will be overridden by the value returned in the
setPrompts call.clearField
- Clears the field that the prompt is placed in if true.echoChar
- Echo character for password. Currently, only '*' is used.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
insertPrompt(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
,
setPrompts(com.ibm.eNetwork.beans.HOD.MacroPrompts)
public void insertPrompt(int row, int col, int len, java.lang.String name, java.lang.String value, boolean clearField) throws MacroException
Note: if macro is not recording, this method will not insert an action.
row
- Row in Presentation Space to place promptcol
- Column in Presentation Space to place promptlen
- Length of prompt. Use this to guard against skip fields.name
- Identifier of prompt. Multiple instances of the same
identifier may appear in a macro.value
- Default value to use for this prompt line only. This
value will be overridden by the value returned in the
setPrompts call.clearField
- Clears the field that the prompt is placed in if true.
MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertPrompt(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String)
,
setPrompts(com.ibm.eNetwork.beans.HOD.MacroPrompts)
public void insertPrompt(int row, int col, int len, java.lang.String name, java.lang.String value, boolean clearField, boolean encrypted, boolean placeValue) throws MacroException
Note: if macro is not recording, this method will not insert an action.
row
- Row in Presentation Space to place promptcol
- Column in Presentation Space to place promptlen
- Length of prompt. Use this to guard against skip fields.name
- Identifier of prompt. Multiple instances of the same
identifier may appear in a macro.value
- Default value to use for this prompt line only. This
value will be overridden by the value returned in the
setPrompts call.clearField
- Clears the field that the prompt is placed in if true.encrypted
- Indicates that text for the prompt should be non-displayable.placeValue
- If true, the text in the value parameter will be placed in the
Screen without the text being recorded.
MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertPrompt(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
,
setPrompts(com.ibm.eNetwork.beans.HOD.MacroPrompts)
public void setPrompts(MacroPrompts p) throws MacroException
MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertPrompt(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
public void insertRunProgram(java.lang.String prog, java.lang.String param, boolean wait) throws MacroException
Note: if macro is not recording, this method will not insert an action.
argProgram
- program to executeargParam
- parameters with which to execute the programargWait
- if true, the macro will wait for the program to return before
continuing to the next actionpublic void insertPause(long argTimeout)
Note: if macro is not recording, this method will not insert an action.
argTimeout
- time to pause in milliseconds, if less than or equal
to 0, no pause will take place.public void insertPlayMacro(java.lang.String argMacName, java.lang.String argScrName, java.lang.String argXferVarType) throws MacroException
Note: if macro is not recording, this method will not insert an action.
argMacName
- Name of Macro to chainargScrName
- Start screen nameargXferVarType
- Whether to transfer variable from current macro to the nextpublic void insertXfer(int argDirection, java.lang.String argHostFile, java.lang.String argPCFile, java.lang.String argOptions, boolean argClear, int argTimeout, java.lang.String argPCCodePage, java.lang.String argHostOrient, java.lang.String argPCOrient, java.lang.String argPCFType, java.lang.String argLamAlefExpan, java.lang.String argLamAlefComp) throws MacroException
Note: if macro is not recording, this method will not insert an action.
argDirection
- direction to transfer, must be either MacroActionXfer.DIRECTION_SEND
or MacroActionXfer.DIRECTION_RECEIVEargHostFile
- name of the host file to transferargPCFile
- name of the PC file to transferargOptions
- host transfer options (contact your host system
administrator for valid file transfer options).argClear
- if true, clears the host screen before the transferargTimeout
- timeout value for the file transfer to go into error.argPCCodePage
- PC code page to use in the transfer, the default
is "037" (English).argHostOrient
- host system orientation used for BiDi systems only.
It is OK for this parameter to be null.argPCOrient
- PC system orientation used for BiDi systems only.
It is OK for this parameter to be null.argPCFType
- PC file type used for BiDi systems only.
It is OK for this parameter to be null.argLamAlefExpan
- Lam Alef expansion option used for Arabic systems only.
It is OK for this parameter to be null.argLamAlefComp
- Lam Alef compression option used for Arabic systems only.
It is OK for this parameter to be null.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertXfer(int, java.lang.String, java.lang.String, java.lang.String, boolean, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void insertXfer(int argDirection, java.lang.String argHostFile, java.lang.String argPCFile, java.lang.String argOptions, boolean argClear, int argTimeout, java.lang.String argPCCodePage, java.lang.String argHostOrient, java.lang.String argPCOrient, java.lang.String argPCFType, java.lang.String argLamAlefExpan, java.lang.String argLamAlefComp, java.lang.String argSymSwap, java.lang.String argNumerals, java.lang.String argRoundTrip) throws MacroException
Note: if macro is not recording, this method will not insert an action.
argDirection
- direction to transfer, must be either MacroActionXfer.DIRECTION_SEND
or MacroActionXfer.DIRECTION_RECEIVEargHostFile
- name of the host file to transferargPCFile
- name of the PC file to transferargOptions
- host transfer options (contact your host system
administrator for valid file transfer options).argClear
- if true, clears the host screen before the transferargTimeout
- timeout value for the file transfer to go into error.argPCCodePage
- PC code page to use in the transfer, the default
is "037" (English).argHostOrient
- host system orientation used for BiDi systems only.
It is OK for this parameter to be null.argPCOrient
- PC system orientation used for BiDi systems only.
It is OK for this parameter to be null.argPCFType
- PC file type used for BiDi systems only.
It is OK for this parameter to be null.argLamAlefExpan
- Lam Alef expansion option used for Arabic systems only.
It is OK for this parameter to be null.argLamAlefComp
- Lam Alef compression option used for Arabic systems only.
It is OK for this parameter to be null.argSymSwap
- Symmetric Swapping used for BiDi systems only.
It is OK for this parameter to be null.argNumerals
- Numerals Shaping option used for Arabic systems only.
It is OK for this parameter to be null.argRoundTrip
- Round Trip option used for Arabic systems only.
It is OK for this parameter to be null.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.insertXfer(int, java.lang.String, java.lang.String, java.lang.String, boolean, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void insertDataExtract(java.lang.String name, int srow, int scol, int erow, int ecol) throws MacroException
Note: if macro is not recording, this method will not insert an action. ECLPS must not be null.
name
- Name of the data extract.srow
- Upper left row of text rectangle to extract from PS.scol
- Upper right column of text rectangle to extract from PS.erow
- Lower left row of text rectangle to extract from PS.ecol
- Lower right column of text rectangle to extract from PS.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
public void insertDataExtract(java.lang.String name, int srow, int scol, int erow, int ecol, java.lang.String planes) throws MacroException
Note: if macro is not recording, this method will not insert an action. ECLPS must not be null.
name
- Name of the data extract.srow
- Upper left row of text rectangle to extract from PS.scol
- Upper right column of text rectangle to extract from PS.erow
- Lower left row of text rectangle to extract from PS.ecol
- Lower right column of text rectangle to extract from PS.planes
- Planes to extract from the PSMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.
public void linkScreens(java.lang.String screenName, java.lang.String nextScreenName) throws MacroException
During playback, if a screen is recognized and its actions are executed, any MacroNextScreens specified must appear after the actions of the current screen are executed. If another screen in the macro appears, and it is not linked to the current screen, an error will occur.
screenName
- name of the screen that contains the linknextScreenName
- name of the screen to link toMacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void linkScreens(java.lang.String screenName, java.lang.String nextScreenName, int timeout) throws MacroException
During playback, if a screen is recognized and its actions are executed, any next screens specified must appear after the current screens actions are executed. If another screen in the macro appears, and it is not linked to the current screen, an error will occur.
screenName
- name of the screen that contains the linknextScreenName
- name of the screen to link totimeout
- timeout value for the Macro bean to wait for any
next screens. If time expires, an error will occur.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setScreenTimeout(java.lang.String name, int timeout) throws MacroException
name
- name of screen to set the next screens timeouttimeout
- timeout value for the Macro bean to wait for any next
screens. If time expires, an error will occur.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.public void setScreenTimeout(int timeout)
timeout
- timeout value for the Macro bean to wait for any next
screens. If time expires, an error will occur.public MacroScreens getParsedMacro()
setMacro(java.lang.String)
,
setMacro(java.io.InputStream)
,
setMacro(java.io.BufferedReader)
public void setParsedMacro(MacroScreens argMS) throws MacroException
argMS
- MacroScreens object that represents a valid macro.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.setMacro(java.lang.String)
,
setMacro(java.io.InputStream)
,
setMacro(java.io.BufferedReader)
public java.lang.String getMacro()
getMacro(java.io.OutputStream)
,
getMacro(java.io.PrintWriter)
public void getMacro(java.io.OutputStream strm) throws MacroException
strm
- OutputStream that the Macro should be written to.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal errorgetMacro()
,
getMacro(java.io.PrintWriter)
public java.lang.String[] getMacroArray()
setMacro(java.io.InputStream)
,
setMacro(java.io.BufferedReader)
public void getMacro(java.io.PrintWriter wrtr) throws MacroException
wrtr
- PrintWriter where the Macro is to be written.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.getMacro()
,
getMacro(java.io.OutputStream)
public void setMacro(java.lang.String str) throws MacroException
str
- String that represents a valid macro.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.setMacro(java.io.InputStream)
,
setMacro(java.io.BufferedReader)
,
setMacroArray(java.lang.String[])
,
setParsedMacro(com.ibm.eNetwork.beans.HOD.MacroScreens)
public void setMacroArray(java.lang.String[] strArray) throws MacroException
strArray
- String array that represents a valid macro.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.setMacro(java.lang.String)
,
setMacro(java.io.InputStream)
,
setMacro(java.io.BufferedReader)
,
setParsedMacro(com.ibm.eNetwork.beans.HOD.MacroScreens)
public void setMacro(java.io.InputStream strm) throws MacroException
strm
- InputStream where the Macro resides.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.setMacro(java.lang.String)
,
setMacro(java.io.BufferedReader)
,
setMacroArray(java.lang.String[])
,
setParsedMacro(com.ibm.eNetwork.beans.HOD.MacroScreens)
public void setMacro(java.io.BufferedReader macReader) throws MacroException
macReader
- BufferedReader where the Macro resides.MacroException
- thrown if a parameter is passed that is not valid or if Macro
experiences an internal error.setMacro(java.lang.String)
,
setMacro(java.io.InputStream)
,
setMacroArray(java.lang.String[])
,
setParsedMacro(com.ibm.eNetwork.beans.HOD.MacroScreens)
public void setMacroIOProvider(MacroIOProvider macIO)
macIO
- MacroIOProvider used for loading chained macrospublic MacroIOProvider getMacroIOProvider()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |