com.ibm.eNetwork.beans.HOD
Class MacroActionPrintEnd

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

public class MacroActionPrintEnd
extends MacroAction

This class represents a printer end action associated with a playing macro script. The end action closes the current active printer job. It does this via a MacroPrinterDriver.closePrinter() call.

This action has this XML tag: <print action="end" .... />

A MacroActionPrintEnd is associated with a MacroScreen to represent a point in the play sequence of the macro script that a printer job should be closed.

There are situations during the play of a macro where an implicit MacroActionPrintEnd will be performed: a MacroActionPrintStart is explicitly performed without an intervening MacroActionPrintEnd, or the playing macro ends.

More than one MacroActionPrintEnd may be issued during the playing of a macro script. It is the programmer responsibility to be sure the flow logic of the playing macro produces the desired printer job(s).

See Also:
Macro.getMacroPrinterDriver(), MacroPrinterDriver.closePrinter(), MacroActionPrintStart, MacroActionPrintExtract, 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
MacroActionPrintEnd()
          The default constructor for this class.
 
Method Summary
 void execute()
          Executes the PrintEnd action.
 java.lang.String format(int argType, boolean displayAll)
          Formats the action object's contents into a readable string.
 java.lang.String getAssignToVar()
          Returns the name of the variable to which the return code for this action will be assigned.
 boolean isAssignToVar()
          Is there a global macro variable to receive the return code result of this call' action performed in the execute() method?
 void setAssignToVar(java.lang.String argAssign)
          Sets the variable to receive the return code of this action.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, equals, halt, setECLSession, setOwner, setRuntimeListeners
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Constructor Detail

MacroActionPrintEnd

public MacroActionPrintEnd()
The default constructor for this class.

If you use this constructor you must call all the set methods of this class to properly set up the action.

See Also:
MacroActionPrintStart.MacroActionPrintStart(), MacroActionPrintExtract.MacroActionPrintExtract()
Method Detail

execute

public void execute()
Executes the PrintEnd action.

At miminum the owning Macro must have been set.

Overrides:
execute in class MacroAction
See Also:
MacroAction.setOwner(com.ibm.eNetwork.beans.HOD.Macro)

getAssignToVar

public java.lang.String getAssignToVar()
Returns the name of the variable to which the return code for this action will be assigned. An empty String indicates that no variable has been designated to receive the assignment.

Returns:
String - The name of variable being updated with the return code of this action.
See Also:
execute(), isAssignToVar(), setAssignToVar(java.lang.String)

isAssignToVar

public boolean isAssignToVar()
Is there a global macro variable to receive the return code result of this call' action performed in the execute() method?
Returns:
boolean - whether there is a variable name specified.
See Also:
execute(), getAssignToVar(), setAssignToVar(java.lang.String)

setAssignToVar

public void setAssignToVar(java.lang.String argAssign)
Sets the variable to receive the return code of this action.

Parameters:
argAssign - The name of the return code assignment variable.
See Also:
execute(), isAssignToVar(), getAssignToVar()

format

public java.lang.String format(int argType,
                               boolean displayAll)
Formats the action object's contents into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class.

Overrides:
format in class MacroAction
Parameters:
argType - Reserved, currently only XML strings are supported.
displayAll - If true, optional parameters will be formatted also.
Returns:
String - The formatted string that reflects the contents of the action.