Package de.xima.fc.interfaces.workflow.validation

Interface IWorkflowGlobalHandlerValidationContext

All Superinterfaces:

IBaseEnvironmentData, IBaseWorkflowEnvironmentData, IWorkflowHandlerValidationContext, IWorkflowValidationContext, IWorkflowValidationEnvironmentData

All Known Implementing Classes:

DefaultWorkflowValidationContext

public interface IWorkflowGlobalHandlerValidationContext
extends IWorkflowValidationContext, IWorkflowHandlerValidationContext

Validation context that is passed to IElementHandler.validateGlobal(de.xima.fc.interfaces.workflow.params.IElementGlobalValidationParams).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
void	addGlobalValidationMessage(ElementKey elementKey, IWorkflowValidationMessage message)	Adds a validations message for the workflow element with the given key.
IWorkflowFlowAnalysis	getFlowAnalysis()
default IWorkflowElementWithDeserializedModel<?,WorkflowNode>	getNodeByUuid(ElementKey key, String nodeType)
IWorkflowElementWithDeserializedModel<?,WorkflowNode>	getNodeByUuid(NodeKey key, String nodeType)
Collection<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>	getNodesByType(String nodeType)
default IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>	getTriggerByUuid(ElementKey key, String triggerType)
IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>	getTriggerByUuid(TriggerKey key, String triggerType)
Collection<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>	getTriggersByType(String triggerType)
void	markGlobalValidationFailed(ElementKey key)	Marks the given workflow element as invalid, when validation failed.

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseEnvironmentData

getClient, getEntityContext, getLocale, getUser

Methods inherited from interface de.xima.fc.interfaces.workflow.params.IBaseWorkflowEnvironmentData

getProject, getWorkflowVersion

Methods inherited from interface de.xima.fc.interfaces.workflow.validation.IWorkflowHandlerValidationContext

getCurrentResourceBundle, getLocalizedMessage

Methods inherited from interface de.xima.fc.interfaces.workflow.validation.IWorkflowValidationContext

getProvider

Method Detail

addGlobalValidationMessage

void addGlobalValidationMessage(ElementKey elementKey,
                                IWorkflowValidationMessage message)

Adds a validations message for the workflow element with the given key.

Parameters:

elementKey - Key of the element to which the validation result applies.

message - Validation message to add.

getFlowAnalysis

IWorkflowFlowAnalysis getFlowAnalysis()

Returns:

A handler for querying data about the execution of the workflow task being validated, such as whether a certain node is reachable from another node.

getNodeByUuid

IWorkflowElementWithDeserializedModel<?,WorkflowNode> getNodeByUuid(NodeKey key,
                                                                          String nodeType)

Parameters:

key - Key of a node to find.

nodeType - Expected type of the node. Pass null or the empty string to return the node irrespective of its type.

Returns:

The node with the given key and the given type in the current workflow process. null when no such node exists.

getNodeByUuid

default IWorkflowElementWithDeserializedModel<?,WorkflowNode> getNodeByUuid(ElementKey key,
                                                                                  String nodeType)

Parameters:

key - Key of a node to find.

nodeType - Expected type of the node. Pass null or the empty string to return the node irrespective of its type.

Returns:

The node with the given key and the given type in the current workflow process. null when no such node exists.

getNodesByType

Collection<IWorkflowElementWithDeserializedModel<?,WorkflowNode>> getNodesByType(String nodeType)

Parameters:

nodeType - Expected type of the node. Pass null or the empty string to return the all nodes.

Returns:

All nodes of the given type, or all nodes when no type is given.

getTriggerByUuid

IWorkflowElementWithDeserializedModel<?,WorkflowTrigger> getTriggerByUuid(TriggerKey key,
                                                                                String triggerType)

Parameters:

key - Key of a trigger to find.

triggerType - Expected type of the trigger. Pass null or the empty string to return the trigger irrespective of its type.

Returns:

The trigger with the given key and the given type in the current workflow process. null when no such node exists.

getTriggerByUuid

default IWorkflowElementWithDeserializedModel<?,WorkflowTrigger> getTriggerByUuid(ElementKey key,
                                                                                        String triggerType)

Parameters:

key - Key of a trigger to find.

triggerType - Expected type of the trigger. Pass null or the empty string to return the trigger irrespective of its type.

Returns:

The trigger with the given key and the given type in the current workflow process. null when no such node exists.

getTriggersByType

Collection<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>> getTriggersByType(String triggerType)

Parameters:

triggerType - Expected type of the trigger. Pass null or the empty string to return the all triggers.

Returns:

All triggers of the given type, or all triggers when no type is given.

markGlobalValidationFailed

void markGlobalValidationFailed(ElementKey key)

Marks the given workflow element as invalid, when validation failed.

Parameters:

key - Key of the element to mark as invalid.