Package com.uc4.api.objects
Class ScheduleTask
java.lang.Object
com.uc4.api.objects.ScheduleTask
- All Implemented Interfaces:
ITaskItem
This class represents a task in a Schedule.
-
Constructor Summary
ConstructorsConstructorDescriptionScheduleTask
(com.uc4.util.XMLDocument doc, Element task) Constructs aScheduleTask
from the specified XML document. -
Method Summary
Modifier and TypeMethodDescriptioncalendar()
Gets the calendar condition of this task.copy()
This method is used to return the copy of the ScheduleTask.void
copy
(ScheduleTask task) Method to copy the attributes from the provided ScheduleTaskint
Returns the number of days which should are added to the start time.getIdnr()
Returns the ID of thisor ScheduleTask
task.int
getLnr()
Returns number containing the order of activation.Returns the start time of this task.Gets the name of this Schedule or Workflow task.getType()
Returns the object type of this task.boolean
boolean
Returnstrue
if the result condition of this Schedule task is set.boolean
boolean
isActive()
Returnstrue
if this task is active.result()
Gets theTaskResult
of this task.runtime()
Returns the runtime settings of this task.void
setActive
(boolean active) Sets thisScheduleTask
active or inactive.void
setDayOffset
(int dayOffset) Sets the number of days which should are added to the start time.protected void
setLnr
(int lnr) void
setStartTime
(Time startTime) Sets the start time of this task.protected void
values()
Provides access to the values and PromptSets of a Schedule or Workflow task.
-
Constructor Details
-
ScheduleTask
Constructs aScheduleTask
from the specified XML document.- Parameters:
doc
- XML Documenttask
- Element containing the schedule task
-
-
Method Details
-
calendar
Description copied from interface:ITaskItem
Gets the calendar condition of this task. -
values
Description copied from interface:ITaskItem
Provides access to the values and PromptSets of a Schedule or Workflow task. -
runtime
Description copied from interface:ITaskItem
Returns the runtime settings of this task. -
getLnr
public int getLnr()Description copied from interface:ITaskItem
Returns number containing the order of activation. A task with Lnr = 1 is executed first. -
result
Gets theTaskResult
of this task. TheTaskResult
may be used to define reactions to the end status of a task. Any task can so be re-activated and/or re-started if the specified status cannot be reached.- Returns:
- Task result
-
getDayOffset
public int getDayOffset()Returns the number of days which should are added to the start time.- Returns:
- Number of days added to the start time
-
setDayOffset
public void setDayOffset(int dayOffset) Sets the number of days which should are added to the start time.- Parameters:
dayOffset
- Number of days added to the start times
-
store
-
getTaskName
Description copied from interface:ITaskItem
Gets the name of this Schedule or Workflow task.- Specified by:
getTaskName
in interfaceITaskItem
- Returns:
- Name of the task
-
getType
Description copied from interface:ITaskItem
Returns the object type of this task. -
isActive
public boolean isActive()Returnstrue
if this task is active.- Returns:
- True if this task is active
-
setActive
public void setActive(boolean active) Sets thisScheduleTask
active or inactive.- Parameters:
active
- Boolean to enable or disable the task
-
getStartTime
Returns the start time of this task.- Returns:
- Start time
-
setStartTime
Sets the start time of this task.- Parameters:
startTime
- Start time
-
setLnr
protected void setLnr(int lnr) -
hasCalendarCondition
public boolean hasCalendarCondition()- Specified by:
hasCalendarCondition
in interfaceITaskItem
- Returns:
- true if this task has a calendar condition.
-
hasRuntimeCondition
public boolean hasRuntimeCondition()- Specified by:
hasRuntimeCondition
in interfaceITaskItem
- Returns:
- true if this task has a runtime condition.
-
hasResultCondition
public boolean hasResultCondition()Returnstrue
if the result condition of this Schedule task is set.- Returns:
- true if the task has a result setting
-
getIdnr
Description copied from interface:ITaskItem
Returns the ID of thisor ScheduleTask
task. -
copy
This method is used to return the copy of the ScheduleTask.- Returns:
- ScheduleTask
-
copy
Method to copy the attributes from the provided ScheduleTask- Parameters:
task
- the ScheduleTask from which the attributes are to be copied- Throws:
IllegalArgumentException
- if the task parameter isnull
-