com.ibm.eNetwork.beans.HOD
Class MacroNextScreens

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.MacroNextScreens
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, java.io.Serializable

public class MacroNextScreens
extends java.lang.Object
implements java.io.Serializable, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, com.ibm.eNetwork.HOD.common.HODConstants

This is a collection class for MacroScreen objects that can follow a particular instance of a MacroScreen object. All of the following screens that can possibly appear as a result of actions on a screen are contained here. These next-screens must exist as other MacroScreen objects in the MacroScreens collection.

Generally, this class would be instantiated, the MacroScreen objects would be added, and the MacroScreens collection would be added to a MacroScreen object (assume an ECLScreenDesc and MacroActions objects are also added to the MacroScreen object). The MacroScreen object(s) could then be added to the Macro bean and the macro played. When the screen appears in the presentation space that matches the MacroScreen object, the MacroAction objects in the MacroActions collection will be executed. After the actions are run, the Macro bean will check the presentation space against the collection of MacroNextScreens. If the screen after the actions matches one of the valid next-screens, all is well. If there is not a match, the macro will end in error. If there are no next-screens, any screen is valid.

See Also:
MacroScreen, Macro, Serialized Form

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, 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_HOD_API, 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_COMPID_ZIPPRINT, 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
MacroNextScreens()
          Constructs an empty instance of a MacroNextScreens object.
 
Method Summary
 void clear()
          Clears the collection of all MacroScreen objects.
 boolean containsName(java.lang.String name)
          Returns whether the nextscreens collection contains the Name of the MacroScreen object or not.
 boolean containsNextScreen(MacroScreen value)
          Returns whether the next-screens collection contains the given MacroScreen object or not.
 java.lang.String format(int argType, boolean displayAll)
          Formats the object's contents into a readable string.
 MacroScreen get(java.lang.String name)
          Returns the MacroScreen object corresponding to the given key in the next-screens collection.
 int getTimeout()
          Returns the timeout value for the next screen to appear.
 java.lang.String getTimeoutRaw()
          Returns the expression form of the timeout value for the next screen to appear.
 boolean isEmpty()
          Returns whether the next-screens collection is empty or not.
 java.util.Enumeration nextScreens()
          Returns an enumeration for all the MacroScreen objects contained in the MacroNextScreens collection.
 MacroScreen put(MacroScreen value)
          Adds the given MacroScreen object corresponding of the given name to the next-screens collection.
 MacroScreen remove(java.lang.String name)
          Removes the MacroScreen object corresponding to the given key from the next-screens collection.
 void setOwner(Macro mac)
          Sets the owner of the action.
 void setTimeout(int argTimeout)
          Sets the timeout value for the next screen to appear.
 void setTimeout(java.lang.String argTimeout)
          Sets the timeout value for the next screen to appear.
 int size()
          Returns the size of the next-screens collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Constructor Detail

MacroNextScreens

public MacroNextScreens()
Constructs an empty instance of a MacroNextScreens object.
Method Detail

clear

public void clear()
Clears the collection of all MacroScreen objects.

containsName

public boolean containsName(java.lang.String name)
Returns whether the nextscreens collection contains the Name of the MacroScreen object or not.
Parameters:
name - unique identifier for the MacroScreen object, corresponds to the Name property in the MacroScreen class
Returns:
true the collection contains the Name, false if not

containsNextScreen

public boolean containsNextScreen(MacroScreen value)
Returns whether the next-screens collection contains the given MacroScreen object or not.
Parameters:
value - MacroScreen object to query
Returns:
true the collection contains the MacroScreen object, false if not

get

public MacroScreen get(java.lang.String name)
Returns the MacroScreen object corresponding to the given key in the next-screens collection.
Parameters:
name - unique identifier for the MacroScreen object, corresponds to the Name property in the MacroScreen class
Returns:
MacroScreen corresponding to the given key, null if not found

isEmpty

public boolean isEmpty()
Returns whether the next-screens collection is empty or not.
Returns:
true the collection is empty, false if not

put

public MacroScreen put(MacroScreen value)
Adds the given MacroScreen object corresponding of the given name to the next-screens collection. Note: the MacroScreen value must have the name parameter set or a NullPointerException will be thrown.
Parameters:
value - MacroScreen object to put in collection
Returns:
the previous value of the specified key in the collection, or null if it did not have one

remove

public MacroScreen remove(java.lang.String name)
Removes the MacroScreen object corresponding to the given key from the next-screens collection.
Parameters:
name - unique identifier for the MacroScreen object, corresponds to the Name property in the MacroScreen class.
Returns:
the value to which the name had been mapped in this hashtable, or null if the key did not have a mapping

size

public int size()
Returns the size of the next-screens collection.

nextScreens

public java.util.Enumeration nextScreens()
Returns an enumeration for all the MacroScreen objects contained in the MacroNextScreens collection.

getTimeout

public int getTimeout()
Returns the timeout value for the next screen to appear. If this value is greater than 0, the default macro timeout is overridden.
Returns:
timeout value for the next screen to appear

getTimeoutRaw

public java.lang.String getTimeoutRaw()
Returns the expression form of the timeout value for the next screen to appear. If this value is greater than 0, the default macro timeout is overridden.
Returns:
expression form of the timeout value for the next screen to appear

setTimeout

public void setTimeout(int argTimeout)
Sets the timeout value for the next screen to appear. If this value is greater than 0, this value overrides the default macro timeout.
Returns:
argTimeout new timeout value for the next screen to appear

setTimeout

public void setTimeout(java.lang.String argTimeout)
Sets the timeout value for the next screen to appear. If this value is greater than 0, this value overrides the default macro timeout.
Returns:
expression new timeout value for the next screen to appear

format

public java.lang.String format(int argType,
                               boolean displayAll)
Formats the object's contents into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class. Note: this method will result in a complete string representation of the Macro. That is, it calls all the format methods for the screens, descriptions, nextscreens, actions, etc.
Specified by:
format in interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
Parameters:
argType - reserved, currently only XML strings are supported
displayAll - if true, optional parameters are formatted also
Returns:
formatted string that reflects the contents of the action

setOwner

public void setOwner(Macro mac)
Sets the owner of the action.
Parameters:
mac - new Macro bean owner of the action