Package com.uc4.api

Class ExecuteTestOptions


  • public class ExecuteTestOptions
    extends java.lang.Object
    Various test options are available in order to execute objects with options. Information about the generation is displayed in the activation protocol depending on the selection you made. The information may be used to analyze whether or not the task was executed properly. For example, script lines may be compared to the generated JCL, or the values of Variables and attributes may be checked.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isGeneratedJCL()
      Returns true if the option generated JCL is selected.
      boolean isModificationOfAttributes()
      Returns true if the option modification of attributes is selected.
      boolean isModificationOfVariables()
      Returns true if the option modification of variables is selected.
      boolean isOriginalScript()
      Returns true if the option Original Script is selected.
      void save​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element testOpt, boolean emptyIfZero)
      Internal use only.
      void setGeneratedJCL​(boolean generatedJCL)
      Sets the option to show the generated JCL in the activation protocol.
      void setModificationOfAttributes​(boolean modificationOfAttributes)
      Sets the option to show the modification of attributes in the activation protocol.
      void setModificationOfVariables​(boolean modificationOfVariables)
      Sets the option to show the modification of variables in the activation protocol.
      void setOriginalScript​(boolean originalScript)
      Sets the option to show the original script in the activation protocol.
      void setShowAttributeDialog​(boolean showAttributeDialog)
      Shows the attribute Dialog.
      boolean showAttributeDialog()
      Returns true if the Attribute Dialog will be opened before the object starts.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ExecuteTestOptions

        public ExecuteTestOptions()
    • Method Detail

      • showAttributeDialog

        public boolean showAttributeDialog()
        Returns true if the Attribute Dialog will be opened before the object starts.
        Returns:
        True if the Attribute Dialog will be shown false otherwise
      • setShowAttributeDialog

        public void setShowAttributeDialog​(boolean showAttributeDialog)
        Shows the attribute Dialog. If this value is set to true the corresponding ExecuteObject request has to be sent using the method sendRequest. The client will be notified by the INotificationListener#read method.
        Parameters:
        showAttributeDialog - True if the attribut dialog should be opened before the object starts
      • isGeneratedJCL

        public boolean isGeneratedJCL()
        Returns true if the option generated JCL is selected.
        Returns:
        JCL
      • setGeneratedJCL

        public void setGeneratedJCL​(boolean generatedJCL)
        Sets the option to show the generated JCL in the activation protocol.
        Parameters:
        generatedJCL - True if the generated JCL should be displayed in the activation protocol
      • isModificationOfAttributes

        public boolean isModificationOfAttributes()
        Returns true if the option modification of attributes is selected.
        Returns:
        True if the modification of attributes should be displayed in the activation protocol
      • setModificationOfAttributes

        public void setModificationOfAttributes​(boolean modificationOfAttributes)
        Sets the option to show the modification of attributes in the activation protocol.
        Parameters:
        modificationOfAttributes - True if the modification of attributes should be displayed in the activation protocol
      • isModificationOfVariables

        public boolean isModificationOfVariables()
        Returns true if the option modification of variables is selected.
        Returns:
        True if the modification of variables should be displayed in the activation protocol
      • setModificationOfVariables

        public void setModificationOfVariables​(boolean modificationOfVariables)
        Sets the option to show the modification of variables in the activation protocol.
        Parameters:
        modificationOfVariables - True if the modification of variables should be displayed in the activation protocol
      • isOriginalScript

        public boolean isOriginalScript()
        Returns true if the option Original Script is selected.
        Returns:
        True if the original script should be displayed in the activation protocol
      • setOriginalScript

        public void setOriginalScript​(boolean originalScript)
        Sets the option to show the original script in the activation protocol.
        Parameters:
        originalScript - True if the original script should be displayed in the activation protocol
      • save

        public void save​(com.uc4.util.XMLDocument doc,
                         org.w3c.dom.Element testOpt,
                         boolean emptyIfZero)
        Internal use only.
        Parameters:
        doc - XML Document
        testOpt - Test options
        emptyIfZero - Workaround for a bug: If the test options are used from the restart, 1 and 0 ist not supported. Instead an empty string must be set (see S# 138968) On the other hand if ExecuteTestOptions are used from execute once, one and zero MUST be used (no empty String allowed) Should be fixed in the XREQ.