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 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 Details

    • ResultActionDefinition

      public ResultActionDefinition(@Nonnull String extensionName)
      Creates a new ResultActionDefinition instance.
      Parameters:
      extensionName - the unique extensionName for the ResultAction. There must be a ResultActionFactory for that extensionName.
      Since:
      taskplanner 3.0
    • ResultActionDefinition

      public ResultActionDefinition(@Nonnull String extensionName, @Nullable Map<String,String> properties)
      Creates a new ResultActionDefinition instance.
      Parameters:
      extensionName - the unique extensionName for the ResultAction. There must be a ResultActionFactory for that extensionName.
      properties - the initial properties to be set, null will have no effect
      Since:
      taskplanner 3.0
  • Method Details