public interface ScheduleTask
Modifier and Type | Method and Description |
---|---|
List<String> |
checkParams()
Returns an empty list, if all params are ok, or a list with complaints, each prefixed with
getName() . |
String |
getClusterNodeName()
If the task execution
should run on a cluster node a node may be specified
for execution. |
String |
getDescription()
Returns the description of this task.
|
boolean |
getExecuteInFault()
Returns
true if this task is to be executed even on previous errors, false to be skipped. |
boolean |
getExecuteParallel()
Returns
true if this task is allowed to be executed parallel, false otherwise. |
String |
getName()
Returns the name of this task.
|
RemoteTaskType |
getRemoteTaskType()
Returns the type of remote task - if the task is executed remote a valid cluster node is choosen according to this type.
|
ScheduleEntry |
getScheduleEntry()
Returns the
ScheduleEntry this task belongs to. |
ScheduleTaskTemplate |
getTemplate()
Returns the
ScheduleTaskTemplate this task uses. |
boolean |
hasTemplate()
Returns
true if this task uses a ScheduleTaskTemplate , false otherwise (default). |
boolean |
isActive()
Returns
true if this task is active, false otherwise. |
boolean |
isExecuteOnClusterNode()
Should the task execution run on a cluster node?
|
boolean |
isProjectTask()
Returns
true if this ScheduleTask is allowed to be used in project context only, false if server context execution is allowed also. |
void |
setActive(boolean value)
Provide
true if this task should be active, false otherwise. |
void |
setClusterNodeName(String value) |
void |
setDescription(String value)
Provide the description of this task.
|
void |
setExecuteInFault(boolean value)
Provide
true if this task is to be executed even on previous errors, false to be skipped. |
void |
setExecuteOnClusterNode(boolean value)
Switch if the task execution should run on a cluster node.
|
void |
setExecuteParallel(boolean value)
Provide
true if this task should be allowed to be executed parallel, false otherwise. |
void |
setName(String value)
Provide the name of this task.
|
void |
setTemplate(ScheduleTaskTemplate template)
Provide the
ScheduleTaskTemplate this task should use. |
ScheduleTaskTestResult |
test()
Returns the test result of this task.
|
void setName(@NotNull String value)
value
- The name of this task.void setDescription(@Nullable String value)
value
- The description of this task.boolean isProjectTask()
true
if this ScheduleTask
is allowed to be used in project context only, false
if server context execution is allowed also.ScheduleTask
can be identified by calling
getScheduleEntry().isProjectSchedule()
or
getScheduleEntry().getProject()
.ScheduleEntry getScheduleEntry()
ScheduleEntry
this task belongs to.ScheduleEntry
@NotNull List<String> checkParams()
getName()
.ScheduleTaskTestResult test()
boolean getExecuteParallel()
true
if this task is allowed to be executed parallel, false
otherwise.void setExecuteParallel(boolean value)
true
if this task should be allowed to be executed parallel, false
otherwise.value
- true
if this task should be allowed to be executed parallel, false
otherwise.boolean isActive()
true
if this task is active, false
otherwise.void setActive(boolean value)
true
if this task should be active, false
otherwise.value
- true
if this task should be active, false
otherwise.boolean hasTemplate()
true
if this task uses a ScheduleTaskTemplate
, false
otherwise (default).ScheduleTaskTemplate
@Nullable ScheduleTaskTemplate getTemplate()
ScheduleTaskTemplate
this task uses.ScheduleTaskTemplate
void setTemplate(@Nullable ScheduleTaskTemplate template)
ScheduleTaskTemplate
this task should use.template
- a ScheduleTaskTemplate
.ScheduleTaskTemplate
boolean isExecuteOnClusterNode()
getRemoteTaskType()
is not
RemoteTaskType.NONE
.setExecuteOnClusterNode(boolean)
,
getClusterNodeName()
,
getRemoteTaskType()
void setExecuteOnClusterNode(boolean value)
getRemoteTaskType()
String getClusterNodeName()
should run on a cluster node
a node may be specified
for execution. If no node is specified the execution will happen on the node with the least load.setClusterNodeName(String)
,
isExecuteOnClusterNode()
,
getRemoteTaskType()
void setClusterNodeName(String value)
@NotNull RemoteTaskType getRemoteTaskType()
RemoteTaskType.NONE
- these indicates that the task cannot be executed on a cluster node.boolean getExecuteInFault()
true
if this task is to be executed even on previous errors, false
to be skipped.void setExecuteInFault(boolean value)
true
if this task is to be executed even on previous errors, false
to be skipped.Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408