Package com.inet.taskplanner.server.api.action

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:

NextTaskActionBuilder, EmailResultActionBuilder, FileSystemResultActionBuilder, PrintResultActionBuilder

Constructor Summary

Constructors

Constructor	Description
ResultActionDefinition(java.lang.String extensionName)	Creates a new ResultActionDefinition instance.
ResultActionDefinition(java.lang.String extensionName, java.util.Map<java.lang.String,java.lang.String> properties)	Creates a new ResultActionDefinition instance.

Method Summary

Modifier and Type	Method	Description
ResultActionDefinition	copyDefinition()	Makes a deep copy of this definition.
boolean	equals(java.lang.Object obj)
ExecutionQualification	getExecutionQualification()	Returns the executionQualification of this ResultActionDefinition
SummaryInfo	getSummary()	Get 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 ResultActionDefinition

Methods inherited from class com.inet.taskplanner.server.api.common.AbstractDefinition

copyDefinitions, getExtensionName, getProperties, getProperty, getUid, removeProperty, setProperty, setUid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultActionDefinition

public ResultActionDefinition(@Nonnull
                              java.lang.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
                              java.lang.String extensionName,
                              @Nullable
                              java.util.Map<java.lang.String,java.lang.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 Detail

copyDefinition

public ResultActionDefinition copyDefinition()

Makes a deep copy of this definition.

Specified by:

copyDefinition in class AbstractDefinition<ResultActionDefinition>

Returns:

a deep copy of this definition.

getExecutionQualification

public ExecutionQualification getExecutionQualification()

Returns the executionQualification of this ResultActionDefinition

Returns:

the executionQualification of this definition

Since:

taskplanner 3.0

setExecutionQualification

public void setExecutionQualification(ExecutionQualification executionQualification)

Sets the executionQualification of this ResultActionDefinition

Parameters:

executionQualification - the executionQualification to set

Throws:

java.lang.IllegalArgumentException - if executionQualification is null.

Since:

taskplanner 3.0

getSummary

public SummaryInfo 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:

java.lang.IllegalStateException - if there is no factory for the extensionName of this definition registered.

Since:

taskplanner 3.0

See Also:

AbstractFactory.getSummary(AbstractDefinition)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDefinition<ResultActionDefinition>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractDefinition<ResultActionDefinition>