Package com.uc4.api.objects
Class JobPlanAttributes
java.lang.Object
com.uc4.api.objects.JobPlanAttributes
This class repesents JobPlan attributes.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the Queue Object for children of this ProcessFlow.Returns the deactivate condition for this JobPlan.Returns the setting for extended reports.Returns the internal account assigned to this JobPlan.Returns the object that is executed when a task does not have the expected end status.Returns the end status that is expected for the subordinated tasks of the JobPlan.int
Priority with which this Workflow should be executed in the Automation Engine.getQueue()
Returns the Queue Object.Returns the start type of this JobPlan.Returns the TimeZone that is to be used.boolean
Returnstrue
if this JobPlan should not be generated at activation time but rather at runtime.boolean
Pass priority to WF childrenboolean
Re-using AgentGroup calculation.Returns settings for parallel tasks.void
setChildrenQueue
(UC4ObjectName childrenQueue) Sets the name of the Queue Object for children of this ProcessFlow.void
setDeactivate
(DeactivateCondition deactivate) Sets the deactivate condition for this JobPlan.void
setExtendedReports
(ExtendedReports extendedReports) Sets the option for extended reports.void
setGenerateAtRuntime
(boolean generateAtRuntime) Sets if this JobPlan should be generated at runtime.void
setIntAccount
(String intAccount) Sets the internal account, max.void
setOkStateExecute
(UC4ObjectName okStateExecute) Sets the object that is executed when a task does not have the expected end status.void
setOkStateForTasks
(TaskState state) Sets the end status that is expected for the subordinated tasks of the JobPlan.void
setPassPriority
(boolean passPriority) void
setPriority
(int priority) Priority with which this Workflow should be executed in the Automation Engine.void
setQueue
(UC4ObjectName queue) Sets the Queue that will be used when this object is executed.void
setReuseAgentGroups
(boolean reuseAgentGroups) Sets the flag for re-using AgentGroup calculation.void
setStartType
(UC4ObjectName startType) Sets the start type of this JobPlan.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this JobPlan.protected void
-
Constructor Details
-
JobPlanAttributes
protected JobPlanAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
-
isReuseAgentGroups
public boolean isReuseAgentGroups()Re-using AgentGroup calculation.- Returns:
- Returns
true
if ProcessFlow tasks of the same AgentGroup should use the same hosts.
-
setReuseAgentGroups
public void setReuseAgentGroups(boolean reuseAgentGroups) Sets the flag for re-using AgentGroup calculation.- Parameters:
reuseAgentGroups
-true
if ProcessFlow tasks of the same AgentGroup should use the same hosts
-
isPassPriority
public boolean isPassPriority()Pass priority to WF children- Returns:
- Returns
true
if the WF priority should be passed on to the children tasks
-
setPassPriority
public void setPassPriority(boolean passPriority) - Parameters:
passPriority
- Istrue
if the WF priority should be passed on to the children tasks
-
getChildrenQueue
Returns the name of the Queue Object for children of this ProcessFlow.- Returns:
- Name of the Queue or
null
if *OWN has been set.
-
setChildrenQueue
Sets the name of the Queue Object for children of this ProcessFlow.- Parameters:
childrenQueue
- Name of the Queue (can be empty) ornull
for *OWN
-
getQueue
Returns the Queue Object.- Returns:
- Name of the Queue Object
-
setQueue
Sets the Queue that will be used when this object is executed.- Parameters:
queue
- Name of the Queue Object
-
getStartType
Returns the start type of this JobPlan.- Returns:
- Start type
-
setStartType
Sets the start type of this JobPlan.- Parameters:
startType
- Start type
-
getIntAccount
Returns the internal account assigned to this JobPlan.- Returns:
- Internal account
-
getDeactivate
Returns the deactivate condition for this JobPlan.- Returns:
- Deactivate condition
-
setDeactivate
Sets the deactivate condition for this JobPlan.- Parameters:
deactivate
- Deactivate condition
-
setIntAccount
Sets the internal account, max. 20 characters.- Parameters:
intAccount
- internal account
-
isGenerateAtRuntime
public boolean isGenerateAtRuntime()Returnstrue
if this JobPlan should not be generated at activation time but rather at runtime.- Returns:
- True if "Generate at runtime" is selected
-
setGenerateAtRuntime
public void setGenerateAtRuntime(boolean generateAtRuntime) Sets if this JobPlan should be generated at runtime.- Parameters:
generateAtRuntime
- If set to true the object is generated at runtime
-
maxParallel
Returns settings for parallel tasks.- Returns:
- parallel task settings
-
getPriority
public int getPriority()Priority with which this Workflow 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 Workflow 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
-
getTimezone
Returns the TimeZone that is to be used.- Returns:
- TimeZone
-
setTimezone
Sets the TimeZone for this JobPlan.- Parameters:
timezone
- TimeZone
-
getOkStateForTasks
Returns the end status that is expected for the subordinated tasks of the JobPlan.- Returns:
- Expected end status
-
setOkStateForTasks
Sets the end status that is expected for the subordinated tasks of the JobPlan.- Parameters:
state
- Expected end status
-
getOkStateExecute
Returns the object that is executed when a task does not have the expected end status.- Returns:
- Name of the object which should be executed
-
setOkStateExecute
Sets the object that is executed when a task does not have the expected end status.- Parameters:
okStateExecute
- Name of the object which should be executed
-
getExtendedReports
Returns the setting for extended reports.- Returns:
- Extended reports.
-
setExtendedReports
Sets the option for extended reports.- Parameters:
extendedReports
- Extended reports.
-