Package com.uc4.api.objects

Class AttributesBS2000

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesBS2000()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    fieldCount()
    Returns the number of fields in the host attributes.
    String
    getEnterParameter()
    Returns enter parameters of this BS2000 Job.
    String
    getJobclass()
    Returns the specification of the Job's class.
    int
    getMaxCPU()
    Returns the maximum CPU time (in seconds) that is available for the Job.
    String
    getOrderName()
    Returns the order name (PNAME).
    int
    getPriority()
    Returns the jobs priority.
    boolean
    isExpress()
    Returns true if the express flag is set for this job.
    boolean
    isSyslstDatabase()
    Returns whether SYSLST protocol is saved only in the Automation Engine database.
    boolean
    isSyslstErrorOnly()
    Returns whether SYSLST protocol is saved only in case of an error.
    boolean
    isSyslstFile()
    Returns whether SYSLST protocol should be available as a file.
    boolean
    isSysoutDatabase()
    Returns whether SYSOUT protocol is saved only in the Automation Engine database.
    boolean
    isSysoutErrorOnly()
    Returns whether SYSOUT protocol is saved only in case of an error.
    boolean
    isSysoutFile()
    Returns whether SYSOUT protocol should be available as a file.
    void
    load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
    Loads the host attributes.
    String
    name()
    Returns the host attributes name.
    void
    setEnterParameter(String enterParameter)
    Sets the enter parameters.
    void
    setExpress(boolean express)
    Sets the express flag.
    void
    setJobclass(String jobclass)
    Sets the job class.
    void
    setMaxCPU(int maxCPU)
    Sets the maximum CPU time (in seconds) that is available for the Job.
    void
    setOrderName(String orderName)
    Sets the order name (PNAME).
    void
    setPriority(int priority)
    Sets the jobs priority.
    void
    setSyslstDatabase(boolean syslstDatabase)
    Sets if the SYSLST protocol should be transfered to the Automation Engine database.
    void
    setSyslstErrorOnly(boolean syslstErrorOnly)
    In case of Job interruption, the SYSLST protocol is saved in the Automation Engine database and/or a file in the target system.
    void
    setSyslstFile(boolean syslstFile)
    Sets if the SYSLST protocol should be available as a file in the target system.
    void
    setSysoutDatabase(boolean sysoutDatabase)
    Sets if the SYSOUT protocol should be transfered to the Automation Engine database.
    void
    setSysoutErrorOnly(boolean sysoutErrorOnly)
    In case of Job interruption, the SYSOUT protocol is saved in the Automation Engine database and/or a file in the target system.
    void
    setSysoutFile(boolean sysoutFile)
    Sets if the SYSOUT protocol should be available as a file in 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

    • AttributesBS2000

      public AttributesBS2000()

  • 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

    • isSyslstDatabase

      public boolean isSyslstDatabase()
      Returns whether SYSLST protocol is saved only in the Automation Engine database.
      Returns:
      true if the SYSOUT protocol is saved in the database false otherwise

    • setSyslstDatabase

      public void setSyslstDatabase(boolean syslstDatabase)
      Sets if the SYSLST protocol should be transfered to the Automation Engine database.
      Parameters:
      syslstDatabase - true if the SYSLSTSOUT protocol should be saved in the database false otherwise

    • isSyslstErrorOnly

      public boolean isSyslstErrorOnly()
      Returns whether SYSLST protocol is saved only in case of an error.
      Returns:
      true if the SYSLST protocol is saved only in case of an error false otherwise

    • setSyslstErrorOnly

      public void setSyslstErrorOnly(boolean syslstErrorOnly)
      In case of Job interruption, the SYSLST protocol is saved in the Automation Engine database and/or a file in the target system. This is only available when "Database" and/or "File" have been selected.
      Parameters:
      syslstErrorOnly - Save SYSLST protocol in error case only

    • isSyslstFile

      public boolean isSyslstFile()
      Returns whether SYSLST protocol should be available as a file.
      Returns:
      true if the SYSLST protocol should be available as a file false otherwise

    • setSyslstFile

      public void setSyslstFile(boolean syslstFile)
      Sets if the SYSLST protocol should be available as a file in the target system.
      Parameters:
      syslstFile - true if the SYSLST protocol should be available as a file

    • isSysoutDatabase

      public boolean isSysoutDatabase()
      Returns whether SYSOUT protocol is saved only in the Automation Engine database.
      Returns:
      true if the SYSOUT protocol is saved in the database false otherwise

    • setSysoutDatabase

      public void setSysoutDatabase(boolean sysoutDatabase)
      Sets if the SYSOUT protocol should be transfered to the Automation Engine database.
      Parameters:
      sysoutDatabase - true if the SYSOUT protocol should be saved in the database false otherwise

    • isSysoutErrorOnly

      public boolean isSysoutErrorOnly()
      Returns whether SYSOUT protocol is saved only in case of an error.
      Returns:
      true if the SYSOUT protocol is saved only in case of an error false otherwise

    • setSysoutErrorOnly

      public void setSysoutErrorOnly(boolean sysoutErrorOnly)
      In case of Job interruption, the SYSOUT protocol is saved in the Automation Engine database and/or a file in the target system. This is only available when "Database" and/or "File" have been selected.
      Parameters:
      sysoutErrorOnly - Save SYSOUT protocol in error case only

    • isSysoutFile

      public boolean isSysoutFile()
      Returns whether SYSOUT protocol should be available as a file.
      Returns:
      true if the SYSOUT protocol should be available as a file false otherwise

    • setSysoutFile

      public void setSysoutFile(boolean sysoutFile)
      Sets if the SYSOUT protocol should be available as a file in the target system.
      Parameters:
      sysoutFile - true if the SYSOUT protocol should be available as a file

    • getEnterParameter

      public String getEnterParameter()
      Returns enter parameters of this BS2000 Job.
      Returns:
      enter parameters

    • setEnterParameter

      public void setEnterParameter(String enterParameter)
      Sets the enter parameters.

      Any number of enter parameters can be set separated with commas. The permitted parameters are dependent on the BS2000 version being used. Their detailed descriptions are found in the "BS2000/OSD Commands" manual under the "/ENTER-JOB" command. 

      Example: TIME=NTL, RERUN-AFTER-CRASH=YES
      The parameter enterParameter must not contain more than 255 characters. Lowercase letters are converted to uppercase.
      Parameters:
      enterParameter - Enter parameter

    • isExpress

      public boolean isExpress()
      Returns true if the express flag is set for this job. If express is set the Job should be immediately started independently of the batch limit.
      Returns:
      express

    • setExpress

      public void setExpress(boolean express)
      Sets the express flag.

      If express is set the Job should be immediately started independently of the batch limit.

      Parameters:
      express - Express flag

    • getJobclass

      public String getJobclass()
      Returns the specification of the Job's class.
      Returns:
      job class

    • setJobclass

      public void setJobclass(String jobclass)
      Sets the job class.

      The parameter is converted to uppercase. The maximum length for jobclass is eight characters.

      Parameters:
      jobclass - job class

    • getMaxCPU

      public int getMaxCPU()
      Returns the maximum CPU time (in seconds) that is available for the Job.
      Returns:
      maximum CPU time in seconds

    • setMaxCPU

      public void setMaxCPU(int maxCPU)
      Sets the maximum CPU time (in seconds) that is available for the Job.

      If the value specified in here is exceeded, the operating system cancels the Job and it gets the Automation Engine status ENDED_VANISHED.

      The value of the parameter maxCPU must be between 0 and 32767.
      Parameters:
      maxCPU - CPU

    • getOrderName

      public String getOrderName()
      Returns the order name (PNAME).
      Returns:
      order name

    • setOrderName

      public void setOrderName(String orderName)
      Sets the order name (PNAME). The parameter orderName is converted to upper case. The maximum length is eight characters. If orderName contains more than eight characters, everything is truncated after the eighth character.
      Parameters:
      orderName - order name

    • getPriority

      public int getPriority()
      Returns the jobs priority.
      Returns:
      priority

    • setPriority

      public void setPriority(int priority)
      Sets the jobs priority. The number range for the priority is 0 to 255.
      Parameters:
      priority - 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