Package com.uc4.api.objects

Class AttributesServer

java.lang.Object
com.uc4.api.objects.AttributesServer
All Implemented Interfaces:
AIJob, IHostAttributes, JobReportAttributes
public class AttributesServer extends Object implements IHostAttributes, AIJob, JobReportAttributes
Attributes of a Server Job executed in JWP.

  • Constructor Details

    • AttributesServer

      public AttributesServer()

  • 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

    • aiAttributes

      public Optional<AIJobAttributes> aiAttributes()
      Description copied from interface: AIJob
      Returns AIJobAttributes or empty if the sub type of the OS Job is not AI.
      Specified by:
      aiAttributes in interface AIJob
      Returns:
      AI job attributes

    • isReportDatabase

      public boolean isReportDatabase()
      Returns whether the job report is transferred to the Automation Engine 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)
      Sets whether the job report should be transferred to the Automation Engine 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()
      Not supported for Server jobs.
      Specified by:
      isReportErrorOnly in interface JobReportAttributes
      Returns:
      true if the job report is stored only in case of Job interruption
      Throws:
      UnsupportedOperationException - always

    • setReportErrorOnly

      public void setReportErrorOnly(boolean reportErrorOnly)
      Not supported for Server jobs.
      Specified by:
      setReportErrorOnly in interface JobReportAttributes
      Parameters:
      reportErrorOnly - true if the job report should be stored only in case of Job interruption
      Throws:
      UnsupportedOperationException - always

    • isReportFile

      public boolean isReportFile()
      Not supported for Server jobs.
      Specified by:
      isReportFile in interface JobReportAttributes
      Returns:
      true if the job report is stored in the file system.
      Throws:
      UnsupportedOperationException - always

    • setReportFile

      public void setReportFile(boolean reportFile)
      Not supported for Server jobs.
      Specified by:
      setReportFile in interface JobReportAttributes
      Parameters:
      reportFile - true if the job report should be stored in the file system
      Throws:
      UnsupportedOperationException - always