Class AfterTaskTriggerFactory

java.lang.Object

com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

com.inet.taskplanner.server.api.common.SeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

com.inet.taskplanner.server.api.trigger.TriggerFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger>

com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory

All Implemented Interfaces:

com.inet.plugin.NamedExtension

public class AfterTaskTriggerFactory
extends TriggerFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger>

Factory for AfterTaskTrigger.

Since:

taskplanner 26.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_NAME	Extension name of this trigger.
static final String	PROPERTY_COMPLETION_MODE	Property key for the completion mode.
static final String	PROPERTY_SOURCE_TASK_ID	Property key for the selected source task ID.
static final String	VALUE_COMPLETION_ALWAYS	Trigger should execute after each finished execution.
static final String	VALUE_COMPLETION_FAILURE	Trigger should execute only after failed executions.
static final String	VALUE_COMPLETION_SUCCESS	Trigger should execute only after successful executions.

Constructor Summary

Constructors

Constructor	Description
AfterTaskTriggerFactory()	Creates an AfterTaskTriggerFactory.

Method Summary

Modifier and Type	Method	Description
protected @Nonnull com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger	createInstanceFrom(@Nonnull TriggerDefinition definition, @Nullable com.inet.id.GUID taskID)	Constructs a component (PRODUCT) from the given definition.
protected @Nonnull List<com.inet.id.GUID>	getAvailableTaskIDs(@Nullable com.inet.id.GUID ownerId)	Resolve available tasks for the source-task selection.
@Nonnull TriggerInfo	getInformation(@Nullable com.inet.id.GUID taskID)	Returns an information object about components which can be produced with this factory.
protected @Nonnull List<com.inet.config.structure.model.LocalizedKey>	getSelectableTaskNames(@Nullable com.inet.id.GUID taskID, @Nullable TaskExecution taskExecution)	Build the selectable source-task names for the settings UI.
@Nonnull SummaryInfo	getSummary(@Nonnull TriggerDefinition definition)	Constructs summary information for the component represented by the given definition.
protected @Nullable TaskDefinition	getTaskDefinition(@Nonnull com.inet.id.GUID taskID)	Resolve a task definition by ID.
protected @Nullable TaskExecution	getTaskExecution(@Nullable com.inet.id.GUID taskID)	Resolve current task execution for task-specific filtering.
protected @Nullable com.inet.id.GUID	parseTaskID(@Nullable String taskID)	Parse task ID from a persisted value.
void	validate(@Nonnull TriggerDefinition definition, @Nullable com.inet.id.GUID taskID)	Validate the given definition.
protected void	validateNoAfterTaskLoop(@Nullable com.inet.id.GUID currentTaskID, @Nonnull com.inet.id.GUID selectedSourceTaskID, @Nonnull List<com.inet.id.GUID> availableTaskIDs)	Validate that choosing the source task does not create a cycle in after-task dependencies.
protected boolean	wouldCreateDependencyLoop(@Nonnull com.inet.id.GUID currentTaskID, @Nonnull com.inet.id.GUID selectedSourceTaskID, @Nonnull List<com.inet.id.GUID> availableTaskIDs)	Check whether choosing the selected source task for the current task forms a cycle in the combined graph of AfterTask triggers and NextTask actions.

Methods inherited from class TriggerFactory

getNextExecutionTimes

Methods inherited from class SeriesIndependentFactory

createFrom, updateValues

Methods inherited from class AbstractFactory

checkDefinitionArgument, createInstanceFrom, getExtensionName, getInformation, getKeywords, isAvailable, isSupportedForSystemTasks

Methods inherited from class Object

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

Field Details

EXTENSION_NAME

public static final String EXTENSION_NAME

Extension name of this trigger.

See Also:

• Constant Field Values

PROPERTY_SOURCE_TASK_ID

public static final String PROPERTY_SOURCE_TASK_ID

Property key for the selected source task ID.

See Also:

• Constant Field Values

PROPERTY_COMPLETION_MODE

public static final String PROPERTY_COMPLETION_MODE

Property key for the completion mode.

See Also:

• Constant Field Values

VALUE_COMPLETION_ALWAYS

public static final String VALUE_COMPLETION_ALWAYS

Trigger should execute after each finished execution.

See Also:

• Constant Field Values

VALUE_COMPLETION_SUCCESS

public static final String VALUE_COMPLETION_SUCCESS

Trigger should execute only after successful executions.

See Also:

• Constant Field Values

VALUE_COMPLETION_FAILURE

public static final String VALUE_COMPLETION_FAILURE

Trigger should execute only after failed executions.

See Also:

• Constant Field Values

Constructor Details

AfterTaskTriggerFactory

public AfterTaskTriggerFactory()

Creates an AfterTaskTriggerFactory.

Since:

26.4

Method Details

createInstanceFrom

protected @Nonnull com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger createInstanceFrom(@Nonnull TriggerDefinition definition,
 @Nullable com.inet.id.GUID taskID)

Constructs a component (PRODUCT) from the given definition.

Overrides:

createInstanceFrom in class AbstractFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

definition - the definition holding information for the PRODUCT

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Returns:

a new PRODUCT

getInformation

public @Nonnull TriggerInfo getInformation(@Nullable com.inet.id.GUID taskID)

Returns an information object about components which can be produced with this factory.

The returned info contains information about how such a component is to be presented in the Task Planner web GUI. This includes display information and available configuration options. The returned information contains fields that describe the values a user can specify in the web GUI. The fields are also responsible for replacing placeholders for the corresponding property in a serial task. That means properties without a field definition will not get any series placeholder replaced.

If you implement a factory for a component used only through the API, you can return null here.

Specified by:

getInformation in class AbstractFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Returns:

an information object for components this factory can produce

validate

public void validate(@Nonnull TriggerDefinition definition,
 @Nullable com.inet.id.GUID taskID)
              throws ValidationException

Validate the given definition.

The given definition is guaranteed to belong to this factory

Specified by:

validate in class SeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

definition - the definition to validate

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Throws:

ValidationException - if the component has some errors

getSummary

public @Nonnull SummaryInfo getSummary(@Nonnull TriggerDefinition definition)

Constructs summary information for the component represented by the given definition.

The summary information is used when the web GUI displays the component.

When implementing a factory for a component to be used only through the API, you can return null here.

Specified by:

getSummary in class AbstractFactory<com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

definition - the definition with the settings made by a user

Returns:

summary information containing text lines to be displayed in the web GUI for this component.

getTaskExecution

protected @Nullable TaskExecution getTaskExecution(@Nullable com.inet.id.GUID taskID)
                                            throws com.inet.permissions.AccessDeniedException

Resolve current task execution for task-specific filtering.

Parameters:

taskID - the configured target task ID

Returns:

execution of the configured task, or null if no task is given

Throws:

com.inet.permissions.AccessDeniedException - if current user cannot read the task

Since:

26.4

getAvailableTaskIDs

protected @Nonnull List<com.inet.id.GUID> getAvailableTaskIDs(@Nullable com.inet.id.GUID ownerId)

Resolve available tasks for the source-task selection.

Parameters:

ownerId - owner of the configured target task, null for system tasks

Returns:

IDs of selectable source tasks

Since:

26.4

getTaskDefinition

protected @Nullable TaskDefinition getTaskDefinition(@Nonnull com.inet.id.GUID taskID)

Resolve a task definition by ID.

Parameters:

taskID - ID of the task

Returns:

task definition, or null if the task no longer exists

Since:

26.4

getSelectableTaskNames

protected @Nonnull List<com.inet.config.structure.model.LocalizedKey> getSelectableTaskNames(@Nullable com.inet.id.GUID taskID,
 @Nullable TaskExecution taskExecution)

Build the selectable source-task names for the settings UI.

Parameters:

taskID - current target task ID

taskExecution - execution of the target task

Returns:

localized options for source-task selection

Since:

26.4

validateNoAfterTaskLoop

protected void validateNoAfterTaskLoop(@Nullable com.inet.id.GUID currentTaskID,
 @Nonnull com.inet.id.GUID selectedSourceTaskID,
 @Nonnull List<com.inet.id.GUID> availableTaskIDs)
                                throws ValidationException

Validate that choosing the source task does not create a cycle in after-task dependencies.

Parameters:

currentTaskID - ID of the task currently configured

selectedSourceTaskID - source task chosen in the trigger settings

availableTaskIDs - visible/selectable tasks for the current owner context

Throws:

ValidationException - if the selected source introduces a dependency loop

Since:

26.4

wouldCreateDependencyLoop

protected boolean wouldCreateDependencyLoop(@Nonnull com.inet.id.GUID currentTaskID,
 @Nonnull com.inet.id.GUID selectedSourceTaskID,
 @Nonnull List<com.inet.id.GUID> availableTaskIDs)

Check whether choosing the selected source task for the current task forms a cycle in the combined graph of AfterTask triggers and NextTask actions.

Parameters:

currentTaskID - ID of the task currently configured

selectedSourceTaskID - source task chosen in the trigger settings

availableTaskIDs - visible/selectable tasks for the current owner context

Returns:

true if a loop would be created

Since:

26.4

parseTaskID

protected @Nullable com.inet.id.GUID parseTaskID(@Nullable String taskID)

Parse task ID from a persisted value.

Parameters:

taskID - task ID as string

Returns:

parsed GUID or null if input is null/invalid

Since:

26.4