com.suncode.pwfl.workflow.form.validator

Class ValidationContext

java.lang.Object

com.suncode.pwfl.workflow.WorkflowContext

com.suncode.pwfl.workflow.form.validator.ValidationContext

All Implemented Interfaces:

Context

@Api
public class ValidationContext
extends WorkflowContext

Validation Context. Active during validation step before activity acceptance. Can be used inside of Validator's to access current activity informations as well as validation errors.

Author:

Rafał Nowacki 10 maj 2016

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationContext(String processId, String activityId, String actionName, ValidationErrors errors)

Method Summary

Modifier and Type	Method and Description
static ValidationContext	activate(String processId, String activityId, String actionName, ValidationErrors errors) Activates validation context.
static void	activate(String processId, String activityId, String actionName, ValidationErrors errors, InContext<ValidationContext> action) Activates validation context and invokes provided action in created context.
static ValidationContext	current() Returns current validation context;
static ValidationContext	deactivate() Deactivates current validation context
String	getActionName() Returns action name or null if default acceptance path is evaluated.
DefinedConfirmation	getConfirmation() Returns confirmations message configured by user.
DefinedError	getError() Returns error message configured by user.
ValidationErrors	getValidationErrors() Returns validation errors object thath holds all errors from all validators.
static boolean	isActive() Returns true if this context is active.
boolean	isDefaultAction() Returns true if default acceptance path is evaluated.
String	name() Returns this context name (for identification purposes)
void	setConfirmation(DefinedConfirmation confirmation)
void	setError(DefinedError error)

Methods inherited from class com.suncode.pwfl.workflow.WorkflowContext

getActivityId, getProcessId

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ValidationContext

protected ValidationContext(String processId,
                            String activityId,
                            String actionName,
                            ValidationErrors errors)

Method Detail

name

public String name()

Description copied from interface: Context

Returns this context name (for identification purposes)

Specified by:

name in interface Context

Overrides:

name in class WorkflowContext

getActionName

public String getActionName()

Returns action name or null if default acceptance path is evaluated.

Returns:

action name

getValidationErrors

public ValidationErrors getValidationErrors()

Returns validation errors object thath holds all errors from all validators.

Returns:

validation errors

getConfirmation

public DefinedConfirmation getConfirmation()

Returns confirmations message configured by user.

Returns:

confirmation message

setConfirmation

public void setConfirmation(DefinedConfirmation confirmation)

getError

public DefinedError getError()

Returns error message configured by user.

Returns:

error message

setError

public void setError(DefinedError error)

isDefaultAction

public boolean isDefaultAction()

Returns true if default acceptance path is evaluated.

Returns:

true for default action

isActive

public static boolean isActive()

Returns true if this context is active.

current

public static ValidationContext current()
                                 throws ContextNotActiveException

Returns current validation context;

Throws:

ContextNotActiveException

activate

public static ValidationContext activate(String processId,
                                         String activityId,
                                         String actionName,
                                         ValidationErrors errors)

Activates validation context.

Parameters:

processId - validated process id

activityId - validated activity id

actionName - action name

errors - validation errors

Returns:

active validation context

activate

public static void activate(String processId,
                            String activityId,
                            String actionName,
                            ValidationErrors errors,
                            InContext<ValidationContext> action)

Activates validation context and invokes provided action in created context.

Parameters:

processId - validated process id

activityId - validated activity id

actionName - action name

errors - validation errors

action - action executed in activated context

deactivate

public static ValidationContext deactivate()

Deactivates current validation context

Returns:

deactivated context