Package com.uc4.api.objects
Class QueueManagerAttributes
java.lang.Object
com.uc4.api.objects.QueueManagerAttributes
Attributes of JOBQ Objects.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the object name of the object that is executed when a task ends with a Return Code greater than the max expected return code.Returns the setting for extended reports.getHost()
Returns the name of the Agent for this job.Method to fetch the host type.Returns the internal account assigned to this Job.int
int
Priority with which this Job should be executed in the Automation Engine.getQueue()
Returns the Queue Object.long
Returns the Max Expected Return Code.Returns the TimeZone that is to be used.boolean
Returnstrue
if the JOBQ task should end when empty.boolean
Returns the filter configuration.boolean
Returnstrue
if the Job should not be generated at activation time but rather at runtime.boolean
boolean
void
setAutoTermination
(boolean autoTermination) The QueueManager object ends automatically when there are no more non-UC4 operations which correspond to the specified filter criteria.void
setConsumption
(int consumption) Sets the consumption value for this Job.void
setElseExecute
(UC4ObjectName elseExecute) Sets the object that is executed when a task has a Return Code greater or equal the than the max expected return code.void
setExtendedReports
(ExtendedReports extendedReports) Sets the option for extended reports.void
setFlatFiltering
(boolean flatFiltering) Sets the configuration for monitored and controlled operations.void
setGenerateAtRuntime
(boolean value) Sets or clears the Generate at runtime check box.void
setHost
(UC4HostName host) Sets the Agent or AgentGroup for this Job.void
setIntAccount
(String intAccount) Sets the internal account, max.void
setMaxParallel
(int maxParallel) void
setPriority
(int priority) Priority with which this Job should be executed in the Automation Engine.void
setQueue
(UC4ObjectName queue) Sets the Queue that will be used when this the Automation Engine object is executed.void
setReportsToDB
(boolean reportsToDB) Sets a flag to indicate if reports should be stored in the the Automation Engine Database.void
setReturnCode
(long returnCode) Sets the Maximum Expected Return Code.void
setStartJobs
(boolean startJobs) If startJobs istrue
, Jobs are started by the Server in case they are not running.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this job.protected void
Stores the content of this job under therequest
element.
-
Constructor Details
-
QueueManagerAttributes
protected QueueManagerAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
Stores the content of this job under therequest
element.- Parameters:
doc
- XML documentrequest
- the newly created elements are children of therequest
element
-
getQueue
Returns the Queue Object.- Returns:
- Name of the Queue Object
-
setQueue
Sets the Queue that will be used when this the Automation Engine object is executed.- Parameters:
queue
- Name of the Queue Object
-
isReportsToDB
public boolean isReportsToDB()- Returns:
- True if reports of ended Jobs should be transfered to the UC4 Database, false otherwise
-
setReportsToDB
public void setReportsToDB(boolean reportsToDB) Sets a flag to indicate if reports should be stored in the the Automation Engine Database.- Parameters:
reportsToDB
- True if reports of ended Jobs should be transfered to the database
-
isFlatFiltering
public boolean isFlatFiltering()Returns the filter configuration.- Returns:
- true if flat filtering should is used, false for hierarchical filtering.
-
setFlatFiltering
public void setFlatFiltering(boolean flatFiltering) Sets the configuration for monitored and controlled operations.- "Flat" - Operations are displayed in vertical order
- "Hierarchical" - The hierarchical view displays existing parent-child relations
- Parameters:
flatFiltering
- Filter configuration, true if flat filtering should be used, false for hierarchical filtering.
-
isAutoTermination
public boolean isAutoTermination()Returnstrue
if the JOBQ task should end when empty.- Returns:
- autoTermination
-
setAutoTermination
public void setAutoTermination(boolean autoTermination) The QueueManager object ends automatically when there are no more non-UC4 operations which correspond to the specified filter criteria.- Parameters:
autoTermination
- true if the JOBQ task should end when empty
-
isStartJobs
public boolean isStartJobs()- Returns:
- True if Jobs are started
-
setStartJobs
public void setStartJobs(boolean startJobs) If startJobs istrue
, Jobs are started by the Server in case they are not running.- Parameters:
startJobs
- true to start Jobs, false for monitoring only
-
isGenerateAtRuntime
public boolean isGenerateAtRuntime()Returnstrue
if the Job should not be generated at activation time but rather at runtime.- Returns:
true
if the Generate at runtime check box is selected
-
setGenerateAtRuntime
public void setGenerateAtRuntime(boolean value) Sets or clears the Generate at runtime check box. ifvalue
istrue
the check box is set.- Parameters:
value
- Generate at runtime
-
getHost
Returns the name of the Agent for this job.- Returns:
- host
-
setHost
Sets the Agent or AgentGroup for this Job.- Parameters:
host
- Host
-
getIntAccount
Returns the internal account assigned to this Job.- Returns:
- Internal account
-
getConsumption
public int getConsumption()- Returns:
- The consumption value which is set for this Job.
-
setConsumption
public void setConsumption(int consumption) Sets the consumption value for this Job. The parameterconsumption
must be between 0 and 100000.- Parameters:
consumption
- Consumption
-
setIntAccount
Sets the internal account, max. 20 characters.- Parameters:
intAccount
- internal account
-
getPriority
public int getPriority()Priority with which this Job should be executed in the Automation Engine. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.- Returns:
- priority
-
setPriority
public void setPriority(int priority) Priority with which this Job should be executed in the Automation Engine. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.- Parameters:
priority
- Priority
-
getMaxParallel
public int getMaxParallel()- Returns:
- Maximum number of parallel tasks, 0 means no tasks will start at all.
-
setMaxParallel
public void setMaxParallel(int maxParallel) - Parameters:
maxParallel
- Maximum number of parallel tasks, 0 means no tasks will start at all.
-
getTimezone
Returns the TimeZone that is to be used.- Returns:
- TimeZone
-
setTimezone
Sets the TimeZone for this job.- Parameters:
timezone
- TimeZone
-
getExtendedReports
Returns the setting for extended reports.- Returns:
- Extended reports.
-
setExtendedReports
Sets the option for extended reports.- Parameters:
extendedReports
- Extended reports.
-
getHostType
Method to fetch the host type.- Returns:
- String Host Type
-
getReturnCode
public long getReturnCode()Returns the Max Expected Return Code.- Returns:
- Long Max Expected Return Code
-
setReturnCode
public void setReturnCode(long returnCode) Sets the Maximum Expected Return Code.- Parameters:
returnCode
- Maximum Expected Return Code
-
getElseExecute
Returns the object name of the object that is executed when a task ends with a Return Code greater than the max expected return code.- Returns:
- Name of the UC4 object which should be executed
-
setElseExecute
Sets the object that is executed when a task has a Return Code greater or equal the than the max expected return code.- Parameters:
elseExecute
- Name of the UC4 object which should be executed
-