All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroNextScreens
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroNextScreens
- public class MacroNextScreens
- extends Object
- implements Serializable, MacroParsable, 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
-
MacroNextScreens()
- Constructs an empty instance of a MacroNextScreens object.
-
clear()
- Clears the collection of all MacroScreen objects.
-
containsName(String)
- Returns whether the nextscreens collection contains the Name of the
MacroScreen object or not.
-
containsNextScreen(MacroScreen)
- Returns whether the next-screens collection contains the given
MacroScreen object or not.
-
format(int, boolean)
- Formats the object's contents into a readable string.
-
get(String)
- Returns the MacroScreen object corresponding to the given key in the
next-screens collection.
-
getTimeout()
- Returns the timeout value for the next screen to appear.
-
isEmpty()
- Returns whether the next-screens collection is empty or not.
-
nextScreens()
- Returns an enumeration for all the MacroScreen objects contained in
the MacroNextScreens collection.
-
put(MacroScreen)
- Adds the given MacroScreen object corresponding of the given name to
the next-screens collection.
-
remove(String)
- Removes the MacroScreen object corresponding to the given key from the
next-screens collection.
-
setOwner(Macro)
- Sets the owner of the action.
-
setTimeout(int)
- Sets the timeout value for the next screen to appear.
-
size()
- Returns the size of the next-screens collection.
MacroNextScreens
public MacroNextScreens()
- Constructs an empty instance of a MacroNextScreens object.
clear
public void clear()
- Clears the collection of all MacroScreen objects.
containsName
public boolean containsName(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(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(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 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
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
format
public 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.
- 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
All Packages Class Hierarchy This Package Previous Next Index