Package com.uc4.api.objects

Class AttributesNSK

java.lang.Object
com.uc4.api.objects.AttributesNSK
All Implemented Interfaces:
IHostAttributes
public class AttributesNSK extends Object implements IHostAttributes
Host attributes for NSK Jobs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesNSK()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    int
    getCpu()
    Returns the number of the CPU on which the Job should run or -1 if the system should selects a CPU.
    int
    getPriority()
    Returns the Job's priority.
    String
    getVhTerm()
    Returns the virual terminal.
    boolean
    isReportDatabase()
    Returns whether the Job report transfered to the Automation Engine 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
    isTypeNBEXEC()
    Returns true if the Job type is NetBatch - NBEXEC scripts.
    boolean
    isTypeOSS()
    Returns true if the Job type is OSS - UNIX commands (osh Shell).
    boolean
    isTypeTACL()
    Returns true if the Job type is Guardian - TACL commands.
    void
    load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
    Loads the host attributes.
    String
    name()
    Returns the host attributes name.
    void
    setCpu(int cpu)
    Sets the number of the CPU on which the Job should run.
    void
    setPriority(int priority)
    Sets the Job's priority.
    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
    setTypeNBEXEC()
    Sets the Job type for NetBatch - NBEXEC scripts.
    void
    setTypeOSS()
    Sets the Job type for OSS - UNIX commands (osh Shell).
    void
    setTypeTACL()
    Sets the Job type for Guardian - TACL commands.
    void
    setVhTerm(String vhTerm)
    Sets the virtual terminal.
    void
    store(com.uc4.util.XMLDocument doc, 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 Details

    • AttributesNSK

      public AttributesNSK()

  • 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

    • getVhTerm

      public String getVhTerm()
      Returns the virual terminal.
      Returns:
      Virtual Terminal

    • setVhTerm

      public void setVhTerm(String vhTerm)
      Sets the virtual terminal.

      Tandem file name comprising of a maximum of 26 alphanumeric characters and the separators \ $ . # and -. Inputs and outputs are made on this device. Therefore, no disk file may be specified as this might cause error messages. Physical or virtual terminals or the corresponding processes (e.g. subtype 30 processes) may be used instead. Use the keyword "none" to suppress the values defined in the INI file.

      Parameters:
      vhTerm - Virtual Terminal

    • getCpu

      public int getCpu()
      Returns the number of the CPU on which the Job should run or -1 if the system should selects a CPU.
      Returns:
      CPU number

    • setCpu

      public void setCpu(int cpu)
      Sets the number of the CPU on which the Job should run. Values between -1 and 15 may be selected. With value -1 being used, the system selects a CPU.
      Parameters:
      cpu - CPU number

    • getPriority

      public int getPriority()
      Returns the Job's priority.
      Returns:
      priority

    • setPriority

      public void setPriority(int priority)
      Sets the Job's priority. Values between 1 and 199 are possible.
      Parameters:
      priority - Priority

    • isTypeNBEXEC

      public boolean isTypeNBEXEC()
      Returns true if the Job type is NetBatch - NBEXEC scripts.
      Returns:
      NBEXEC Job type

    • setTypeNBEXEC

      public void setTypeNBEXEC()
      Sets the Job type for NetBatch - NBEXEC scripts.

    • isTypeOSS

      public boolean isTypeOSS()
      Returns true if the Job type is OSS - UNIX commands (osh Shell).
      Returns:
      OSS Job type

    • setTypeOSS

      public void setTypeOSS()
      Sets the Job type for OSS - UNIX commands (osh Shell).

    • setTypeTACL

      public void setTypeTACL()
      Sets the Job type for Guardian - TACL commands.

    • isTypeTACL

      public boolean isTypeTACL()
      Returns true if the Job type is Guardian - TACL commands.
      Returns:
      TACL Job type

    • isReportDatabase

      public boolean isReportDatabase()
      Returns whether the Job report transfered to the Automation Engine 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