com.ibm.eNetwork.beans.HOD
Class MacroActionPrintStart

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

public class MacroActionPrintStart
extends MacroAction

This class represents a printer start action associated with a playing macro script. The start action configures and opens the macro printer driver for the playing macro. This signals the start of the current printer job. It does this via a MacroPrinterDriver.openPrinter() call.

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

A MacroActionPrintStart is associated with a MacroScreen to represent a point in the play sequence of the macro script that a printer job should be opened. The printer job will persist until there is a subsequent MacroActionPrintEnd or other action that implicitly ends the current printer job. That may occur on a different MacroScreenObject.

More than one MacroActionPrintStart 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.openPrinter(), MacroActionPrintEnd, 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
MacroActionPrintStart()
          The default constructor for this class.
MacroActionPrintStart(java.util.Properties p)
          A non-default constructor for the situation where the printer stream configuration properties need to be specified.
 
Method Summary
 void execute()
          Executes the PrintStart 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.
 java.util.Properties getCurrentProperties()
          This Properties is the current configuration of the macro printer driver.
 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.
 void setCodePage(int codePage)
          This usage of this call is in the context of:
public int com.ibm.eNetowrk.ECL.ECLConnection.GetCodePage(),
which gets the host code page of a live host session.
 void setCurrentProperties(java.util.Properties p)
          The specified Properties will set the configuration of the macro printer driver.
 void setOwner(Macro m)
          The action of this macro action class is valid only in the context of an owning Macro instance, which is referred to obtain critical state parameters.
 void setProperties(java.util.Properties p)
          Sets the the printer stream configuration properties.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, equals, halt, setECLSession, 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

MacroActionPrintStart

public MacroActionPrintStart()
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:
MacroActionPrintExtract.MacroActionPrintExtract(), MacroActionPrintEnd.MacroActionPrintEnd()

MacroActionPrintStart

public MacroActionPrintStart(java.util.Properties p)
A non-default constructor for the situation where the printer stream configuration properties need to be specified.

Parameters:
p - - The configuration properties container.

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

execute

public void execute()
Executes the PrintStart action.

At miminum the owning Macro and an ECLSession must have been set.

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

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.

setProperties

public void setProperties(java.util.Properties p)
Sets the the printer stream configuration properties.
Parameters:
p - - The configuration properties container.

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()

getCurrentProperties

public java.util.Properties getCurrentProperties()
This Properties is the current configuration of the macro printer driver.

Returns:
Properties - The current printer driver configuration.
See Also:
setCurrentProperties(java.util.Properties)

setCurrentProperties

public void setCurrentProperties(java.util.Properties p)
The specified Properties will set the configuration of the macro printer driver.

Parameters:
p - Properties object contains the configuration key-value pairs.
See Also:
getCurrentProperties()

setOwner

public void setOwner(Macro m)
The action of this macro action class is valid only in the context of an owning Macro instance, which is referred to obtain critical state parameters.

Overrides:
setOwner in class MacroAction
Parameters:
m - The Macro that provides the action context.

setCodePage

public void setCodePage(int codePage)
This usage of this call is in the context of:
public int com.ibm.eNetowrk.ECL.ECLConnection.GetCodePage(),
which gets the host code page of a live host session.
Parameters:
codePage - - The numeric value for the host code page.