AttributesOS400 (java-api 12.2.10 API)

java.lang.Object
- com.uc4.api.objects.AttributesOS400

All Implemented Interfaces:: IHostAttributes

public class AttributesOS400
extends Object
implements IHostAttributes

Host attributes for OS/400 Jobs.

Constructor Summary

Constructors
Constructor and Description

AttributesOS400()

Constructors
Constructor and Description
`AttributesOS400()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`fieldCount()` Returns the number of fields in the host attributes.
`String`	`getJobDescription()` Returns the name of the Job description used for this Job in the form Library/Job description.
`String`	`getJobName()` Returns the Job name.
`String`	`getJobQueue()` Returns the name of the Job queue in which the this Job has been put.
`int`	`getPriority()` Returns the priority with which the Job should be executed.
`String`	`getRoutingData()` Returns the rooting data with which the Job's first rooting step is initiated.
`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`	`isSpoolAll()` Returns `true` if the entire spool contents of the Job is saved.
`boolean`	`isSpoolQPJOBLOG()` Returns `true` if the spool contents from QPJOBLOG is saved.
`boolean`	`isTypeCMD()` Returns `true` if the type CMD is selected.
`boolean`	`isTypeILE_CL()` Returns `true` if the type ILE CL is selected.
`boolean`	`isTypeREXX()` Returns `true` if the type REXX is selected.
`void`	`load(com.uc4.util.XMLDocument doc, Element hostAttr)` Loads the host attributes.
`String`	`name()` Returns the host attributes name.
`void`	`setJobDescription(String jobDescription)` Sets the name of the Job description used for this Job in the form Library/Job description.
`void`	`setJobName(String jobName)` Sets the name which is assigned to the Job during its processing.
`void`	`setJobQueue(String jobQueue)` Sets the name of the Job queue in which the this Job has been put.
`void`	`setPriority(int priority)` Sets the priority with which the Job should be executed.
`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`	`setRoutingData(String rootingData)` Sets the rooting data with which the Job's first rooting step is initiated.
`void`	`setSpoolAll()` The entire spool contents of the Job are saved in the Automation Engine database and/or are available as a member in the target system.
`void`	`setSpoolQPJOBLOG()` Only the spool contents from QPJOBLOG are saved in the Automation Engine database and/or are available as a member in the target system.
`void`	`setTypeCMD()` The Job consists of OS/400 commands.
`void`	`setTypeILE_CL()` The Job consists of an ILE CL script and is compiled by the Agent before the execution.
`void`	`setTypeREXX()` The Job consists of a REXX script and is given to the interpreter.
`void`	`store(com.uc4.util.XMLDocument doc, Element objectElement)` Writes the host attributes back to the `XMLDocument`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AttributesOS400
```
public AttributesOS400()
```
- Method Detail
  - 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)
```
    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
  - 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)
```
    Description copied from interface: IHostAttributes
    
    Writes the host attributes back to the XMLDocument.
    
    Specified by:
    
    store in interface IHostAttributes
    
    Parameters:
    
    doc - Document
    
    objectElement - ObjectElement
  - getRoutingData
```
public String getRoutingData()
```
    Returns the rooting data with which the Job's first rooting step is initiated.
    
    Returns:
    
    Rooting data
  - setRoutingData
```
public void setRoutingData(String rootingData)
```
    Sets the rooting data with which the Job's first rooting step is initiated. With the rooting data, the root entry (which indicates the program executed by the Job) is determined. Default value: *JOBD rootingData is converted to upper case. Maximum 255 characters are allowed for rootingData.
    
    Parameters:
    
    rootingData - Rooting data
  - getJobQueue
```
public String getJobQueue()
```
    Returns the name of the Job queue in which the this Job has been put.
    
    Returns:
    
    Job queue
  - setJobQueue
```
public void setJobQueue(String jobQueue)
```
    Sets the name of the Job queue in which the this Job has been put. This appears in the form Library/Job queue where the library may be left out. Default value: *JOBD jobQueue is converted to upper case. Maximum 21 characters are allowed for jobQueue.
    
    Parameters:
    
    jobQueue - Job queue
  - getJobDescription
```
public String getJobDescription()
```
    Returns the name of the Job description used for this Job in the form Library/Job description.
    
    Returns:
    
    Job Description
  - setJobDescription
```
public void setJobDescription(String jobDescription)
```
    Sets the name of the Job description used for this Job in the form Library/Job description. The library may be left out. Default value: *USRPRF jobDescription is converted to upper case. Maximum 21 characters are allowed for jobDescription.
    
    Parameters:
    
    jobDescription - Job Description
  - getPriority
```
public int getPriority()
```
    Returns the priority with which the Job should be executed.
    
    Returns:
    
    Priority
  - setPriority
```
public void setPriority(int priority)
```
    Sets the priority with which the Job should be executed. The priority is a value of 1 (highest priority) to 99 (lowest priority). This value represents the intent of the Job if the Job competes with other Jobs for system resources. If a value has been specified, the Agent - after successful SBMJOB - executes a CHGJOB with this priority.
    
    Parameters:
    
    priority - Priority
  - getJobName
```
public String getJobName()
```
    Returns the Job name.
    
    Returns:
    
    Job name
  - setJobName
```
public void setJobName(String jobName)
```
    Sets the name which is assigned to the Job during its processing. If this attribute is not specified, the Agent creates the name in the form "J" + 7-figure RunID + 2-figure client number. Example: J0421121504 The paramter jobName is converted to upper case. Maximum 10 characters are allowed for jobName.
    
    Parameters:
    
    jobName - Job Name
  - isTypeREXX
```
public boolean isTypeREXX()
```
    Returns true if the type REXX is selected.
    
    Returns:
    
    Type REXX
  - setTypeREXX
```
public void setTypeREXX()
```
    The Job consists of a REXX script and is given to the interpreter. The Job's Return Code may be set with the REXX statement
```
 retcode = 6
 
```
  - isTypeILE_CL
```
public boolean isTypeILE_CL()
```
    Returns true if the type ILE CL is selected.
    
    Returns:
    
    Type ILE CL
  - setTypeILE_CL
```
public void setTypeILE_CL()
```
    The Job consists of an ILE CL script and is compiled by the Agent before the execution. The compiled CL program subsequently executed. The Job's Return Code may be set with the CL command
```
 "CHGVAR VAR(&RETCODE) VALUE('0')"
 
```
  - isTypeCMD
```
public boolean isTypeCMD()
```
    Returns true if the type CMD is selected.
    
    Returns:
    
    Type CMD
  - setTypeCMD
```
public void setTypeCMD()
```
    The Job consists of OS/400 commands. If an error occurs in one of these commands, the Job ends incorrectly. The severity code is set as the Job's Return Code.
  - isSpoolAll
```
public boolean isSpoolAll()
```
    Returns true if the entire spool contents of the Job is saved.
    
    Returns:
    
    ALL
  - setSpoolAll
```
public void setSpoolAll()
```
    The entire spool contents of the Job are saved in the Automation Engine database and/or are available as a member in the target system.
  - setSpoolQPJOBLOG
```
public void setSpoolQPJOBLOG()
```
    Only the spool contents from QPJOBLOG are saved in the Automation Engine database and/or are available as a member in the target system.
  - isSpoolQPJOBLOG
```
public boolean isSpoolQPJOBLOG()
```
    Returns true if the spool contents from QPJOBLOG is saved.
    
    Returns:
    
    QPJOBLOG
  - 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

Class AttributesOS400

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AttributesOS400

Method Detail

fieldCount

load

name

store

getRoutingData

setRoutingData

getJobQueue

setJobQueue

getJobDescription

setJobDescription

getPriority

setPriority

getJobName

setJobName

isTypeREXX

setTypeREXX

isTypeILE_CL

setTypeILE_CL

isTypeCMD

setTypeCMD

isSpoolAll

setSpoolAll

setSpoolQPJOBLOG

isSpoolQPJOBLOG

isReportDatabase

setReportDatabase

isReportErrorOnly

setReportErrorOnly

isReportFile

setReportFile