Package com.uc4.api.objects
Class ScheduleAttributes
java.lang.Object
com.uc4.api.objects.ScheduleAttributes
This class represents attributes of a Schedule.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the Queue Object for children of this Schedule.Returns the setting for extended reports.Returns the internal account assigned to this job.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 Schedule.int
Returns the period in days of this Schedule.int
Priority with which this Job should be executed in the Automation Engine.getQueue()
Returns the Queue Object.Returns the start type of this job.Returns the TimeZone that is to be used.Returns the turn around time of the Schedule.boolean
Returnstrue
if the Job should not be generated at activation time but rather at runtime.Returns settings for parallel tasks.void
setChildrenQueue
(UC4ObjectName childrenQueue) Sets the name of the Queue Object for children of this Schedule.void
setExtendedReports
(ExtendedReports extendedReports) Sets the option for extended reports.void
setGenerateAtRuntime
(boolean generateAtRuntime) Enables or disables runtime generation.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 Schedule.void
setPeriod
(int period) Sets the period of this Schedule.void
setPriority
(int i) 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 Automation Engine object is executed.void
setStartType
(UC4ObjectName startType) Sets the start type of this job.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this Schedule.void
setTurnaround
(Time startTime) Sets the turn around time of the Schedule.protected void
-
Constructor Details
-
ScheduleAttributes
protected ScheduleAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
getPeriod
public int getPeriod()Returns the period in days of this Schedule.- Returns:
- Period in days
-
setPeriod
public void setPeriod(int period) Sets the period of this Schedule. Values between 1 and 99 are allowed.- Parameters:
period
- Period
-
store
-
getChildrenQueue
Returns the name of the Queue Object for children of this Schedule.- Returns:
- Name of the Queue or
null
if *OWN has been set.
-
setChildrenQueue
Sets the name of the Queue Object for children of this Schedule.- 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 Automation Engine object is executed.- Parameters:
queue
- Name of the Queue Object
-
getIntAccount
Returns the internal account assigned to this job.- Returns:
- internal account
-
setIntAccount
Sets the internal account, max. 20 characters.- Parameters:
intAccount
- internal account
-
getStartType
Returns the start type of this job.- Returns:
- start type
-
setStartType
Sets the start type of this job.- Parameters:
startType
- start type
-
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 generateAtRuntime) Enables or disables runtime generation.- Parameters:
generateAtRuntime
- Generate at runtime
-
getTurnaround
Returns the turn around time of the Schedule.- Returns:
- Turn around time
-
setTurnaround
Sets the turn around time of the Schedule.- Parameters:
startTime
- Turn around time
-
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 i) 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:
i
- Priority
-
maxParallel
Returns settings for parallel tasks.- Returns:
- parallel task settings
-
getTimezone
Returns the TimeZone that is to be used.- Returns:
- TimeZone
-
setTimezone
Sets the TimeZone for this Schedule.- Parameters:
timezone
- TimeZone
-
getOkStateForTasks
Returns the end status that is expected for the subordinated tasks of the Schedule.- Returns:
- Expected end status
-
setOkStateForTasks
Sets the end status that is expected for the subordinated tasks of the Schedule.- 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 UC4 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 Automation Engine 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.
-