Package com.uc4.api.objects

Class AttributesMPE

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesMPE()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    int
    getInputPriority()
    Returns the input priority (INPRI).
    String
    getJobName()
    Returns the job name.
    String
    getOther()
    Returns additional Job parameters.
    String
    getQueue()
    Returns the Queue in which this Job should run.
    boolean
    isHipri()
    Returns true if HIPRI is active.
    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
    setHipri(boolean hipri)
    Enables or disables HIPRI.
    void
    setInputPriority(int inputPriority)
    Sets the input priority (INPRI).
    void
    setJobName(String jobName)
    Specification of a name under which the Job should be executed.
    void
    setOther(String other)
    Sets additional parameters for the "JOB" command.
    void
    setQueue(String queue)
    Sets the Queue in which this Job should run.
    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
    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

    • AttributesMPE

      public AttributesMPE()

  • 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

    • getOther

      public String getOther()
      Returns additional Job parameters.
      Returns:
      additional parameters

    • setOther

      public void setOther(String other)
      Sets additional parameters for the "JOB" command. A maximum of 256 characters are possible. The parameters must be specified according to the syntax.
      Parameters:
      other - additional parameters

    • isHipri

      public boolean isHipri()
      Returns true if HIPRI is active.
      Returns:
      HIPRI

    • setHipri

      public void setHipri(boolean hipri)
      Enables or disables HIPRI.

      HIPRI may be used to overwrite the Job fence or the limit for Jobs set to be executed. The authorizations System Manager (SM) or System Operator (OM) are required.

      Parameters:
      hipri - HIPRI

    • getInputPriority

      public int getInputPriority()
      Returns the input priority (INPRI). This value is used for the logon of the Job.
      Returns:
      input priority

    • setInputPriority

      public void setInputPriority(int inputPriority)
      Sets the input priority (INPRI). This value is used for the logon of the Job. A value between "1" and "13" may be use for Input Priority. The default value is "8". *
      Parameters:
      inputPriority - input priority

    • getQueue

      public String getQueue()
      Returns the Queue in which this Job should run.
      Returns:
      Queue

    • setQueue

      public void setQueue(String queue)
      Sets the Queue in which this Job should run. Queues for selection are managed in the Automation Engine Variable "UC_MPE_QUEUE" of the client "0000". A maximum of 8 characters are allowed for user-defined queues.
      Parameters:
      queue - Job Queue

    • getJobName

      public String getJobName()
      Returns the job name.
      Returns:
      job name

    • setJobName

      public void setJobName(String jobName)
      Specification of a name under which the Job should be executed. A maximum of 8 alphanumeric characters are allowed. The first must be a letter.
      Parameters:
      jobName - Name of the Job

    • 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