Package com.uc4.api.objects

Class AttributesGCOS8

java.lang.Object
com.uc4.api.objects.AttributesGCOS8
All Implemented Interfaces:
IHostAttributes
public class AttributesGCOS8 extends Object implements IHostAttributes
Host attributes for GCOS 8.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesGCOS8()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    String
    getIdent()
    Returns the name for the $ IDENT statement.
    String
    getIncludeJob()
    Returns the path and name of a file containing a Job.
    String
    getSnumb()
    Returns the sequence number of the Job.
    int
    getUrgency()
    Returns the priority with which the Job should be executed.
    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.
    void
    load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
    Loads the host attributes.
    String
    name()
    Returns the host attributes name.
    void
    setIdent(String ident)
    Sets the name for the $ IDENT statement ident must not contain more than 63 characters.
    void
    setIncludeJob(String includeJob)
    Sets the path and name of a file containing a Job.
    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
    setSnumb(String snumb)
    Sets the sequence number of the Job.
    void
    setUrgency(int urgency)
    Specification of the priority with which the Job should be executed.
    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

    • AttributesGCOS8

      public AttributesGCOS8()

  • Method Details

    • 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

    • 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

    • 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

    • getIdent

      public String getIdent()
      Returns the name for the $ IDENT statement.
      Returns:
      IDENT statement

    • setIdent

      public void setIdent(String ident)
      Sets the name for the $ IDENT statement ident must not contain more than 63 characters.
      Parameters:
      ident - IDENT statement

    • getIncludeJob

      public String getIncludeJob()
      Returns the path and name of a file containing a Job.
      Returns:
      path to job

    • setIncludeJob

      public void setIncludeJob(String includeJob)
      Sets the path and name of a file containing a Job.

      This Job is executed just before the Trailer is processed and must therefore not contain a $ ENDJOB statement!

      includeJob must not contain more than 255 characters.
      Parameters:
      includeJob - path to job

    • getSnumb

      public String getSnumb()
      Returns the sequence number of the Job.

      If no particular number has been specified, it is created automatically. The Agent's INI file contains the parameter SNUMB_SUFFIX which may be used to define the appended character.

      Returns:
      sequence number

    • setSnumb

      public void setSnumb(String snumb)
      Sets the sequence number of the Job.

      If no particular number has been specified, it is created automatically. The Agent's INI file contains the parameter SNUMB_SUFFIX which may be used to define the appended character.

      The parameter will be converted to upper case. The length must not exceed 5 characters.
      Parameters:
      snumb - sequence number

    • getUrgency

      public int getUrgency()
      Returns the priority with which the Job should be executed.
      Returns:
      priority

    • setUrgency

      public void setUrgency(int urgency)
      Specification of the priority with which the Job should be executed. A value between "0" and "63" may be entered.
      Parameters:
      urgency - priority

    • 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

    • name

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