Package com.uc4.api.objects
Class AttributesRA
java.lang.Object
com.uc4.api.objects.AttributesRA
- All Implemented Interfaces:
IHostAttributes
Host attributes for RA Jobs.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of fields in the host attributes.boolean
boolean
Returns whether the Job report transfered to the Automation Engine database.boolean
Returnstrue
if the Job report will be stored only in case of Job interruption.boolean
Returnstrue
if the Job report is stored in the file system on the target system.boolean
Returns the value of the runtime option "Request task parameters".void
load
(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info) Loads the host attributes.name()
Returns the host attributes name.void
setAgentLog
(boolean agentLog) Sets the Agent Process Log for this SAP Job.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
setRequestTaskParameter
(boolean requestTaskParameter) Sets the value of the runtime option "Request task parameters".void
store
(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes info) Writes the host attributes back to theXMLDocument
.
-
Constructor Details
-
AttributesRA
public AttributesRA()
-
-
Method Details
-
fieldCount
public int fieldCount()Description copied from interface:IHostAttributes
Returns the number of fields in the host attributes.- Specified by:
fieldCount
in interfaceIHostAttributes
- Returns:
- number of fields
-
load
Description copied from interface:IHostAttributes
Loads the host attributes.- Specified by:
load
in interfaceIHostAttributes
- Parameters:
doc
- XML Document containing the JobhostAttr
- Element which contains host attributesinfo
- Session details
-
name
Description copied from interface:IHostAttributes
Returns the host attributes name.- Specified by:
name
in interfaceIHostAttributes
- Returns:
- name
-
store
Description copied from interface:IHostAttributes
Writes the host attributes back to theXMLDocument
.- Specified by:
store
in interfaceIHostAttributes
- Parameters:
doc
- DocumentobjectElement
- ObjectElementinfo
- Session details
-
isAgentLog
public boolean isAgentLog()- Returns:
- True if the Agent Process Log should be transfered
-
setAgentLog
public void setAgentLog(boolean agentLog) Sets the Agent Process Log for this SAP Job.- Parameters:
agentLog
- true if the Log should be transfered
-
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 databasefalse
otherwise
-
isRequestTaskParameter
public boolean isRequestTaskParameter()Returns the value of the runtime option "Request task parameters".- Returns:
- true if the task parameters should be shown when the object is executed
-
setRequestTaskParameter
public void setRequestTaskParameter(boolean requestTaskParameter) Sets the value of the runtime option "Request task parameters".- Parameters:
requestTaskParameter
- true if the task parameters should be shown when the object is executed
-
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 databasefalse
otherwise
-
isReportErrorOnly
public boolean isReportErrorOnly()Returnstrue
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()Returnstrue
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
-