com.suncode.pwfl.workflow.form.datachooser

Class DataChooserContext

java.lang.Object

com.suncode.pwfl.workflow.WorkflowContext

com.suncode.pwfl.workflow.form.datachooser.DataChooserContext

All Implemented Interfaces:

Context

@Api
public class DataChooserContext
extends WorkflowContext

DataChooser Context. Active during invoking datachooser. Can be used inside of DataChooser's to access invocation data and result as well as activity information.

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	DataChooserContext(String processId, String activityId, ComponentQueryData queryData, DataChooserResult result, Collection<MappingDeclaration> mappings)

Method Summary

Modifier and Type	Method and Description
static DataChooserContext	activate(String processId, String activityId, ComponentQueryData queryData, DataChooserResult result, Collection<MappingDeclaration> mappings) Activates validation context.
static void	activate(String processId, String activityId, ComponentQueryData queryData, DataChooserResult result, Collection<MappingDeclaration> mappings, InContext<DataChooserContext> action) Activates validation context and invokes provided action in created context.
static DataChooserContext	current() Returns current validation context;
static DataChooserContext	deactivate() Deactivates current validation context
List<MappingDeclaration>	getMappings() Returns datachooser declared mappings.
Parameters	getParameters()
ComponentQueryData	getQueryData() Returns query data used to fetch result.
DataChooserResult	getResult() Returns datachooser result.
static boolean	isActive() Returns true if this context is active.
String	name() Returns this context name (for identification purposes)
void	setParameters(Parameters parameters)

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

DataChooserContext

protected DataChooserContext(String processId,
                             String activityId,
                             ComponentQueryData queryData,
                             DataChooserResult result,
                             Collection<MappingDeclaration> mappings)

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

getQueryData

public ComponentQueryData getQueryData()

Returns query data used to fetch result.

Returns:

queryData query data

getResult

public DataChooserResult getResult()

Returns datachooser result.

Returns:

result datachooser result

getMappings

public List<MappingDeclaration> getMappings()

Returns datachooser declared mappings.

Returns:

result datachooser declared mappings

getParameters

public Parameters getParameters()

setParameters

public void setParameters(Parameters parameters)

isActive

public static boolean isActive()

Returns true if this context is active.

current

public static DataChooserContext current()
                                  throws ContextNotActiveException

Returns current validation context;

Throws:

ContextNotActiveException

activate

public static DataChooserContext activate(String processId,
                                          String activityId,
                                          ComponentQueryData queryData,
                                          DataChooserResult result,
                                          Collection<MappingDeclaration> mappings)

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,
                            ComponentQueryData queryData,
                            DataChooserResult result,
                            Collection<MappingDeclaration> mappings,
                            InContext<DataChooserContext> 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 DataChooserContext deactivate()

Deactivates current validation context

Returns:

deactivated context