Class ResultActionDefinition
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractDefinition<ResultActionDefinition>
com.inet.taskplanner.server.api.action.ResultActionDefinition
@JsonData
public final class ResultActionDefinition
extends AbstractDefinition<ResultActionDefinition>
Definition of a ResultAction for a configured
A ResultAction does something with the results of
TaskExecution
.A ResultAction does something with the results of
jobs
.
ResultActionDefinition
——extensionName
—⟶ResultActionFactory
——createFrom()
—⟶ResultAction
To map from a ResultActionDefinition
to a ResultActionFactory
the method AbstractDefinition.getExtensionName()
has to return a name
for which a ResultActionFactory
is registered in the ServerPluginManager
.
This definition also includes settings for the action, i.e. for a file system action the path to store the result to.
The extension name and the valid properties are usually defined and documented in the corresponding ResultActionFactory
.
An Action can be flagged with a ExecutionQualification
, which specifies whether this Action must be executed
when certain jobs
did not finish a valid result (condition).
- Since:
- taskplanner 3.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionResultActionDefinition
(@Nonnull String extensionName) Creates a new ResultActionDefinition instance.ResultActionDefinition
(@Nonnull String extensionName, @Nullable Map<String, String> properties) Creates a new ResultActionDefinition instance. -
Method Summary
Modifier and TypeMethodDescriptionMakes a deep copy of this definition.boolean
Returns the executionQualification of this ResultActionDefinitionGet a summary information with list of String-pars which summarizes the settings for this ResultAction in the webgui.int
hashCode()
void
setExecutionQualification
(ExecutionQualification executionQualification) Sets the executionQualification of this ResultActionDefinitionMethods inherited from class com.inet.taskplanner.server.api.common.AbstractDefinition
copyDefinitions, getExtensionName, getProperties, getProperty, getUid, removeProperty, setProperty, setUid
-
Constructor Details
-
ResultActionDefinition
Creates a new ResultActionDefinition instance.- Parameters:
extensionName
- the unique extensionName for theResultAction
. There must be aResultActionFactory
for that extensionName.- Since:
- taskplanner 3.0
-
ResultActionDefinition
public ResultActionDefinition(@Nonnull @Nonnull String extensionName, @Nullable @Nullable Map<String, String> properties) Creates a new ResultActionDefinition instance.- Parameters:
extensionName
- the unique extensionName for theResultAction
. There must be aResultActionFactory
for that extensionName.properties
- the initial properties to be set,null
will have no effect- Since:
- taskplanner 3.0
-
-
Method Details
-
copyDefinition
Makes a deep copy of this definition.- Specified by:
copyDefinition
in classAbstractDefinition<ResultActionDefinition>
- Returns:
- a deep copy of this definition.
-
getExecutionQualification
Returns the executionQualification of this ResultActionDefinition- Returns:
- the executionQualification of this definition
- Since:
- taskplanner 3.0
-
setExecutionQualification
Sets the executionQualification of this ResultActionDefinition- Parameters:
executionQualification
- the executionQualification to set- Throws:
IllegalArgumentException
- if executionQualification is null.- Since:
- taskplanner 3.0
-
getSummary
Get a summary information with list of String-pars which summarizes the settings for this ResultAction in the webgui.- Returns:
- summary information, can be null if factory decides to return null
- Throws:
IllegalStateException
- if there is no factory for the extensionName of this definition registered.- Since:
- taskplanner 3.0
- See Also:
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractDefinition<ResultActionDefinition>
-
equals
- Overrides:
equals
in classAbstractDefinition<ResultActionDefinition>
-