Package com.uc4.api.objects

Class AttributesVMS

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesVMS()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    String
    getJobName()
    Returns the name under which a Job should be executed.
    int
    getPriority()
    Returns the priority for the Job.
    String
    getQueueName()
    Returns the name of the queue in which the Job should be activated.
    boolean
    isReportDatabase()
    Returns whether the Job report transfered to the 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
    setJobName(String jobName)
    Specification of the name under which a Job should be executed.
    void
    setPriority(int priority)
    Specification of the priority for the Job.
    void
    setQueueName(String queueName)
    Specification of the queue in which the Job should be activated.
    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

    • AttributesVMS

      public AttributesVMS()

  • 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

    • getQueueName

      public String getQueueName()
      Returns the name of the queue in which the Job should be activated.
      Returns:
      Queue name

    • setQueueName

      public void setQueueName(String queueName)
      Specification of the queue in which the Job should be activated. Maximum 31 characters permitted.
      Parameters:
      queueName - Queue name

    • getJobName

      public String getJobName()
      Returns the name under which a Job should be executed.
      Returns:
      Job name

    • setJobName

      public void setJobName(String jobName)
      Specification of the name under which a Job should be executed. Maximum 39 characters permitted.
      Parameters:
      jobName - Job name

    • getPriority

      public int getPriority()
      Returns the priority for the Job.
      Returns:
      Priority

    • setPriority

      public void setPriority(int priority)
      Specification of the priority for the Job. A value between "0" and "255" may be entered. Priority is currently not analyzed by VMS.
      Parameters:
      priority - Priority

    • isReportDatabase

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