Package com.uc4.api.objects

Class AttributesUnix

java.lang.Object
com.uc4.api.objects.AttributesUnix
All Implemented Interfaces:
IHostAttributes, JobReportAttributes, PythonJob
public class AttributesUnix extends Object implements IHostAttributes, PythonJob, JobReportAttributes
Host attributes for UNIX Jobs.

  • Constructor Details

    • AttributesUnix

      public AttributesUnix()

  • Method Details

    • 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, 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 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, 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

    • getCommand

      public String getCommand()
      Returns the shell command.
      Returns:
      Command

    • setCommand

      public void setCommand(String command)
      Set a single shell command or sequence of shell commands. Is sent to the shell and executed there. Multiple commands separated by semicolons. A maximum of 255 charcters is allowed for command.
      Parameters:
      command - Command

    • getShellOptions

      public String getShellOptions()
      Returns shell options. The syntax of the parameters for calling the shell is dependent on the respective Unix Shell.
      Returns:
      Shell options

    • setShellOptions

      public void setShellOptions(String shellOptions)
      Specification of shell options. The syntax of the parameters for calling the shell is dependent on the respective Unix Shell. A maximum of 16 charcters is allowed for shellOptions.
      Parameters:
      shellOptions - Shell options

    • getShell

      public String getShell()
      Returns the Unix Shell, under which the Job should run.
      Returns:
      Unix Shell

    • setShell

      public void setShell(String shell)
      Sets the Unix Shell, under which the Job should run. If no shell is selected, the Automation Engine uses the standard shell from the password file. A maximum of 8 characters is allowed for shell.
      Parameters:
      shell - Unix Shell

    • isTypeCommand

      public boolean isTypeCommand()
      Returns true if the Job type is Command.
      Returns:
      Command

    • setTypeCommand

      public void setTypeCommand()
      The command or command sequence, stored in the "Command" field, are given to the UNIX command line. The shell defined in this tab is the one called. If no shell is defined, the standard shell is used.

    • isTypeShellScript

      public boolean isTypeShellScript()
      Returns true if the Job type is Shell Script.
      Returns:
      Shell Script

    • setTypeShellScript

      public void setTypeShellScript()
      A Job is generated, transferred to the target system and executed as a shell script. The JCL for the UNIX Job is stored in the "Script" tab.

    • isReportDatabase

      public boolean isReportDatabase()
      Description copied from interface: JobReportAttributes
      Returns whether the Job report transfered to the database.
      Specified by:
      isReportDatabase in interface JobReportAttributes
      Returns:
      true if the Job report is transfered to the database false otherwise

    • setReportDatabase

      public void setReportDatabase(boolean reportDatabase)
      Description copied from interface: JobReportAttributes
      Sets whether the Job report should be transfered to the database.
      Specified by:
      setReportDatabase in interface JobReportAttributes
      Parameters:
      reportDatabase - true if the job report should be transfered to the database false otherwise

    • isReportErrorOnly

      public boolean isReportErrorOnly()
      Description copied from interface: JobReportAttributes
      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.
      Specified by:
      isReportErrorOnly in interface JobReportAttributes
      Returns:
      true if the job report is stored only in case of Job interruption

    • setReportErrorOnly

      public void setReportErrorOnly(boolean reportErrorOnly)
      Description copied from interface: JobReportAttributes
      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.
      Specified by:
      setReportErrorOnly in interface JobReportAttributes
      Parameters:
      reportErrorOnly - true if the job report should be stored only in case of Job interruption

    • isReportFile

      public boolean isReportFile()
      Description copied from interface: JobReportAttributes
      Returns true if the Job report is stored in the file system on the target system.
      Specified by:
      isReportFile in interface JobReportAttributes
      Returns:
      true if the job report is stored in the file system.

    • setReportFile

      public void setReportFile(boolean reportFile)
      Description copied from interface: JobReportAttributes
      Sets whether the Job report should be stored in the file system on the target system.
      Specified by:
      setReportFile in interface JobReportAttributes
      Parameters:
      reportFile - true if the job report should be stored in the file system

    • pythonAttributes

      public Optional<PythonJobAttributes> pythonAttributes()
      Description copied from interface: PythonJob
      Returns PythonJobAttributes or empty if the sub type of the OS Job is not Python.
      Specified by:
      pythonAttributes in interface PythonJob
      Returns:
      Python job attributes