Package com.uc4.api.objects

Class AttributesRA

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesRA()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    boolean
    isAgentLog()
     
    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
    isRequestTaskParameter()
    Returns the value of the runtime option "Request task parameters".
    void
    load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
    Loads the host attributes.
    String
    name()
    Returns the host attributes name.
    void
    setAgentLog(boolean agentLog)
    Sets the Agent Process Log for this SAP 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
    setRequestTaskParameter(boolean requestTaskParameter)
    Sets the value of the runtime option "Request task parameters".
    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

    • AttributesRA

      public AttributesRA()

  • 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

    • isAgentLog

      public boolean isAgentLog()
      Returns:
      True if the Agent Process Log should be transfered

    • setAgentLog

      public void setAgentLog(boolean agentLog)
      Sets the Agent Process Log for this SAP Job.
      Parameters:
      agentLog - true if the Log should be transfered

    • 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

    • isRequestTaskParameter

      public boolean isRequestTaskParameter()
      Returns the value of the runtime option "Request task parameters".
      Returns:
      true if the task parameters should be shown when the object is executed

    • setRequestTaskParameter

      public void setRequestTaskParameter(boolean requestTaskParameter)
      Sets the value of the runtime option "Request task parameters".
      Parameters:
      requestTaskParameter - true if the task parameters should be shown when the object is executed

    • 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