Package com.uc4.api.objects

Class AttributesWin

  • All Implemented Interfaces:
    IHostAttributes
    public class AttributesWin
extends java.lang.Object
implements IHostAttributes
    Host attributes for Windows Jobs.

    • Constructor Summary

      Constructors 
      Constructor Description
      AttributesWin()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int fieldCount()
      Returns the number of fields in the host attributes.
      java.lang.String getCommand()
      Returns the program to be executed.
      java.lang.String getWorkingDirectory()
      Returns the working directory in which the Job should run.
      boolean isGeneratedByScript()
      Returns true if the Job report is generated by script.
      boolean isJobObjectDefault()
      Returns true if Job Object is set to default.
      boolean isJobObjectNo()
      Returns true if Job Object is set to no.
      boolean isJobObjectYes()
      Returns true if Job Object is set to yes.
      boolean isLogOnAsBatch()
      Returns true if the Job is executed in batch mode.
      boolean isReportDatabase()
      Returns whether the Job report transfered to the database.
      boolean isReportErrorOnly()
      Returns true if the Job report will be stored only in case of Job interruption.
      boolean isReportFile()
      Returns true if the Job report is stored in the file system on the target system.
      boolean isShowAtDesktop()
      Returns true if the Job is executed and visible to a logged-on user.
      boolean isTypeBAT()
      Returns true if type BAT is selected.
      boolean isTypeCOM()
      Returns true if type COM is selected.
      boolean isTypeInterpreter()
      Returns true if type Interpreter is selected.
      boolean isViewMaximized()
      Returns true if the view is set to maximized.
      boolean isViewMinimized()
      Returns true if the view is set to minimized.
      boolean isViewStandard()
      Returns true if the view is set to standard.
      void load​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr, ConnectionAttributes info)
      Loads the host attributes.
      java.lang.String name()
      Returns the host attributes name.
      void setCommand​(java.lang.String command)
      Sets the program to be executed.
      void setGeneratedByScript​(boolean isGeneratedByScript)
      Sets whether the script should generate the Job report instead of STDOUT/STERR.
      void setJobObjectDefault()
      Whether or not the Windows Job Object is used depends on the configuration settings made in the INI file of the Agent.
      void setJobObjectNo()
      The Job does not use the Windows Job Object.
      void setJobObjectYes()
      The Job uses the Windows Job Object.
      void setLogOnAsBatch​(boolean logOnAsBatch)
      If set the Job is executed in batch mode and is not visible to a logged-on user.
      void setReportDatabase​(boolean reportDatabase)
      Sets whether the Job report should be transfered to the database.
      void setReportErrorOnly​(boolean reportErrorOnly)
      Sets whether the Job report should be stored only in case of Job interruption.
      void setReportFile​(boolean reportFile)
      Sets whether the Job report should be stored in the file system on the target system.
      void setShowAtDesktop​(boolean showAtDesktop)
      If set the Job is executed and visible to a logged-on user.
      void setTypeBAT()
      The script statements and DATA lines stored in the script are executed as MS-DOS batch file.
      void setTypeCOM()
      The program stored in the field "Command" is executed.
      void setTypeInterpreter()
      The processing stored in the script is transferred to an Interpreter as a file.
      void setViewMaximized()
      Sets the display to maximized.
      void setViewMinimized()
      Sets the display to minimized.
      void setViewStandard()
      Set the display to normal view.
      void setWorkingDirectory​(java.lang.String workingDirectory)
      Sets the working directory in which the Job should run.
      void store​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes info)
      Writes the host attributes back to the XMLDocument.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AttributesWin

        public AttributesWin()

    • Method Detail

      • fieldCount

        public int fieldCount()
        Description copied from interface: IHostAttributes
        Returns the number of fields in the host attributes.
        Specified by:
        fieldCount in interface IHostAttributes
        Returns:
        number of fields

      • load

        public void load​(com.uc4.util.XMLDocument doc,
                 org.w3c.dom.Element hostAttr,
                 ConnectionAttributes info)
        Description copied from interface: IHostAttributes
        Loads the host attributes.
        Specified by:
        load in interface IHostAttributes
        Parameters:
        doc - XML Document containing the Job
        hostAttr - Element which contains host attributes
        info - Session details

      • name

        public java.lang.String name()
        Description copied from interface: IHostAttributes
        Returns the host attributes name.
        Specified by:
        name in interface IHostAttributes
        Returns:
        name

      • store

        public void store​(com.uc4.util.XMLDocument doc,
                  org.w3c.dom.Element objectElement,
                  ConnectionAttributes info)
        Description copied from interface: IHostAttributes
        Writes the host attributes back to the XMLDocument.
        Specified by:
        store in interface IHostAttributes
        Parameters:
        doc - Document
        objectElement - ObjectElement
        info - Session details

      • isShowAtDesktop

        public boolean isShowAtDesktop()
        Returns true if the Job is executed and visible to a logged-on user.
        Returns:
        Show job on the desktop

      • setShowAtDesktop

        public void setShowAtDesktop​(boolean showAtDesktop)
        If set the Job is executed and visible to a logged-on user. This way the Job may be displayed in Windows during its processing in an MS DOS window.
        Parameters:
        showAtDesktop - Show job on the desktop

      • isLogOnAsBatch

        public boolean isLogOnAsBatch()
        Returns true if the Job is executed in batch mode.
        Returns:
        Logon as batch user

      • setLogOnAsBatch

        public void setLogOnAsBatch​(boolean logOnAsBatch)
        If set the Job is executed in batch mode and is not visible to a logged-on user.
        Parameters:
        logOnAsBatch - Logon as batch user

      • getCommand

        public java.lang.String getCommand()
        Returns the program to be executed.
        Returns:
        Command

      • setCommand

        public void setCommand​(java.lang.String command)
        Sets the program to be executed. The complete path may be specified if needed. Type "COM" is required. A maximum number of 255 characters is allowed for command.
        Parameters:
        command - Command

      • getWorkingDirectory

        public java.lang.String getWorkingDirectory()
        Returns the working directory in which the Job should run.
        Returns:
        Working directory

      • setWorkingDirectory

        public void setWorkingDirectory​(java.lang.String workingDirectory)
        Sets the working directory in which the Job should run. A maximum number of 255 characters is allowed for workingDirectory.
        Parameters:
        workingDirectory - Working directory

      • isJobObjectNo

        public boolean isJobObjectNo()
        Returns true if Job Object is set to no.
        Returns:
        No

      • setJobObjectNo

        public void setJobObjectNo()
        The Job does not use the Windows Job Object.

      • isJobObjectYes

        public boolean isJobObjectYes()
        Returns true if Job Object is set to yes.
        Returns:
        Yes

      • setJobObjectYes

        public void setJobObjectYes()
        The Job uses the Windows Job Object.

      • isJobObjectDefault

        public boolean isJobObjectDefault()
        Returns true if Job Object is set to default.
        Returns:
        Default

      • setJobObjectDefault

        public void setJobObjectDefault()
        Whether or not the Windows Job Object is used depends on the configuration settings made in the INI file of the Agent.

      • isViewMaximized

        public boolean isViewMaximized()
        Returns true if the view is set to maximized.
        Returns:
        Maximized

      • setViewMaximized

        public void setViewMaximized()
        Sets the display to maximized. The display is enlarged to full screen.

      • isViewMinimized

        public boolean isViewMinimized()
        Returns true if the view is set to minimized.
        Returns:
        Minimized

      • setViewMinimized

        public void setViewMinimized()
        Sets the display to minimized.

      • isViewStandard

        public boolean isViewStandard()
        Returns true if the view is set to standard.
        Returns:
        Standard

      • setViewStandard

        public void setViewStandard()
        Set the display to normal view.

      • isTypeInterpreter

        public boolean isTypeInterpreter()
        Returns true if type Interpreter is selected.
        Returns:
        Interpreter

      • setTypeInterpreter

        public void setTypeInterpreter()
        The processing stored in the script is transferred to an Interpreter as a file. For this, the INI file in the [GLOBAL] section must contain the following entries: 
         ECPEXE=Interpreter
        and 
         ECPEXT=File Extension.

      • isTypeCOM

        public boolean isTypeCOM()
        Returns true if type COM is selected.
        Returns:
        Use Command field

      • setTypeCOM

        public void setTypeCOM()
        The program stored in the field "Command" is executed. The complete path and command line may be specified if needed.

      • isTypeBAT

        public boolean isTypeBAT()
        Returns true if type BAT is selected.
        Returns:
        Use Batch file

      • setTypeBAT

        public void setTypeBAT()
        The script statements and DATA lines stored in the script are executed as MS-DOS batch file.

      • isGeneratedByScript

        public boolean isGeneratedByScript()
        Returns true if the Job report is generated by script.
        Returns:
        Is generated by script

      • setGeneratedByScript

        public void setGeneratedByScript​(boolean isGeneratedByScript)
        Sets whether the script should generate the Job report instead of STDOUT/STERR.
        Parameters:
        isGeneratedByScript - Is generated by script

      • isReportDatabase

        public boolean isReportDatabase()
        Returns whether the Job report transfered to the database.
        Returns:
        true if the Job report is transfered to the database false otherwise

      • setReportDatabase

        public void setReportDatabase​(boolean reportDatabase)
        Sets whether the Job report should be transfered to the database.
        Parameters:
        reportDatabase - true if the job report should be transfered to the database false otherwise

      • isReportErrorOnly

        public boolean isReportErrorOnly()
        Returns true if the Job report will be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
        Returns:
        true if the job report is stored only in case of Job interruption

      • setReportErrorOnly

        public void setReportErrorOnly​(boolean reportErrorOnly)
        Sets whether the Job report should be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
        Parameters:
        reportErrorOnly - true if the job report should be stored only in case of Job interruption

      • isReportFile

        public boolean isReportFile()
        Returns true if the Job report is stored in the file system on the target system.
        Returns:
        true if the job report is stored in the file system.

      • setReportFile

        public void setReportFile​(boolean reportFile)
        Sets whether the Job report should be stored in the file system on the target system.
        Parameters:
        reportFile - true if the job report should be stored in the file system