IWorkflowLocalValidationContext (formcycle: bom 8.1.2 API)

All Superinterfaces:: IBaseEnvironmentData, IBaseWorkflowEnvironmentData, IWorkflowValidationContext, IWorkflowValidationEnvironmentData

All Known Subinterfaces:: IWorkflowLocalBeanValidationContext, IWorkflowLocalHandlerValidationContext

All Known Implementing Classes:: DefaultWorkflowValidationContext, FacesWorkflowLocalValidationContext, InjectableValidationContext

public interface IWorkflowLocalValidationContext extends IWorkflowValidationContext

Context holding data required during a local workflow validation process, i.e. when each node gets validated individually.

Since:: 7.0.0
Author:: XIMA MEDIA GmbH

Method Summary

Modifier and Type

Method

Description

<T> T

associateValue(Object key, Function<IWorkflowLocalValidationContext,T> supplier)

Associates the given value for the duration of the workflow validation process.

IWorkflowElementValidationResultBuilder

resultBuilder()

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseEnvironmentData
getClient, getEntityContext, getLocale, getUser, getUserModel

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

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

Method Details
- associateValue
  
  <T> T associateValue(Object key, Function<IWorkflowLocalValidationContext,T> supplier)
  
  Associates the given value for the duration of the workflow validation process. Once validation is done, the values are discarded.
  
  Type Parameters:
  
  T - Type of the associate value.
  
  Parameters:
  
  key - Key for the association.
  
  supplier - Supplier that produces the value when not yet present.
  
  Returns:
  
  The associated value.
- resultBuilder
  
  IWorkflowElementValidationResultBuilder resultBuilder()
  
  Returns:
  
  Builder for creating the result that needs to be returned by IElementHandler#validateLocal. This is provided for convenience, you can also create your own implementation of IWorkflowElementValidationResult.