public class AttributesBS2000 extends java.lang.Object implements IHostAttributes
Constructor and Description |
---|
AttributesBS2000() |
Modifier and Type | Method and Description |
---|---|
int |
fieldCount()
Returns the number of fields in the host attributes.
|
java.lang.String |
getEnterParameter()
Returns enter parameters of this BS2000 Job.
|
java.lang.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.
|
java.lang.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,
org.w3c.dom.Element hostAttr)
Loads the host attributes.
|
java.lang.String |
name()
Returns the host attributes name.
|
void |
setEnterParameter(java.lang.String enterParameter)
Sets the enter parameters.
|
void |
setExpress(boolean express)
Sets the express flag.
|
void |
setJobclass(java.lang.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(java.lang.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,
org.w3c.dom.Element objectElement)
Writes the host attributes back to the
XMLDocument . |
public void load(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr)
IHostAttributes
load
in interface IHostAttributes
doc
- XML Document containing the JobhostAttr
- Element which contains host attributespublic void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement)
IHostAttributes
XMLDocument
.store
in interface IHostAttributes
doc
- DocumentobjectElement
- ObjectElementpublic boolean isSyslstDatabase()
true
if the SYSOUT protocol is saved in the database
false
otherwisepublic void setSyslstDatabase(boolean syslstDatabase)
syslstDatabase
- true
if the SYSLSTSOUT protocol should be saved in the database
false
otherwisepublic boolean isSyslstErrorOnly()
true
if the SYSLST protocol is saved only in case of an
error false
otherwisepublic void setSyslstErrorOnly(boolean syslstErrorOnly)
syslstErrorOnly
- Save SYSLST protocol in error case onlypublic boolean isSyslstFile()
true
if the SYSLST protocol should be available as a file false
otherwisepublic void setSyslstFile(boolean syslstFile)
syslstFile
- true
if the SYSLST protocol should be available as a filepublic boolean isSysoutDatabase()
true
if the SYSOUT protocol is saved in the database
false
otherwisepublic void setSysoutDatabase(boolean sysoutDatabase)
sysoutDatabase
- true
if the SYSOUT protocol should be saved in the database
false
otherwisepublic boolean isSysoutErrorOnly()
true
if the SYSOUT protocol is saved only in case of an
error false
otherwisepublic void setSysoutErrorOnly(boolean sysoutErrorOnly)
sysoutErrorOnly
- Save SYSOUT protocol in error case onlypublic boolean isSysoutFile()
true
if the SYSOUT protocol should be available as a file false
otherwisepublic void setSysoutFile(boolean sysoutFile)
sysoutFile
- true
if the SYSOUT protocol should be available as a filepublic java.lang.String getEnterParameter()
public void setEnterParameter(java.lang.String enterParameter)
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=YESThe parameter
enterParameter
must not contain more than 255 characters.
Lowercase letters are converted to uppercase.enterParameter
- Enter parameterpublic boolean isExpress()
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.public void setExpress(boolean express)
If express is set the Job should be immediately started independently of the batch limit.
express
- Express flagpublic java.lang.String getJobclass()
public void setJobclass(java.lang.String jobclass)
The parameter is converted to uppercase. The maximum length for jobclass
is
eight characters.
jobclass
- job classpublic int getMaxCPU()
public void setMaxCPU(int maxCPU)
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 parametermaxCPU
must be between 0 and 32767.maxCPU
- CPUpublic java.lang.String getOrderName()
public void setOrderName(java.lang.String orderName)
orderName
is converted to uppercase. The maximum length is eight characters.orderName
- order namepublic int getPriority()
public void setPriority(int priority)
priority
- Prioritypublic int fieldCount()
IHostAttributes
fieldCount
in interface IHostAttributes
public java.lang.String name()
IHostAttributes
name
in interface IHostAttributes