com.atlassian.jira.functest.framework.admin
Interface WorkflowTransition

All Known Implementing Classes:

WorkflowTransitionImpl

public interface WorkflowTransition

Represents functionality of the workflow transition configuration page.

Since:

v4.3

Nested Class Summary

static class

WorkflowTransition.Tabs

Method Summary

WorkflowTransition	addWorkflowCondition(String workflowConditionKey) Add workflow condition with given workflowConditionKey to the transition.
WorkflowTransition	addWorkflowCondition(String workflowConditionKey, Map<String,String> configFormParams) Add workflow condition with given workflowConditionKey to the transition.
WorkflowTransition	addWorkflowFunction(String workflowFunctionKey) Add workflow function with given workflowFunctionKey to the transition.
WorkflowTransition	addWorkflowFunction(String workflowFunctionKey, Map<String,String> configFormParams) Add workflow function with given workflowFunctionKey to the transition.
WorkflowTransition	addWorkflowValidator(String workflowValidatorKey) Add workflow validator with given workflowValidatorKey to the transition.
WorkflowTransition	addWorkflowValidator(String workflowValidatorKey, Map<String,String> configFormParams) Add workflow validator with given workflowValidatorKey to the transition.
boolean	canAddWorkflowCondition(String workflowConditionKey) Check if condition with given workflowConditionKey can be added to this transition, i.e.
boolean	canAddWorkflowFunction(String workflowFunctionKey) Check if function with given workflowFunctionKey can be added to this transition, i.e.
boolean	canAddWorkflowValidator(String workflowValidatorKey) Check if validator with given workflowValidatorKey can be added to this transition, i.e.
WorkflowTransition	goToAddWorkflowCondition() Go to the 'Add Workflow Condition' form where user can choose between available workflow conditions to add to the transition.
WorkflowTransition	goToAddWorkflowFunction() Go to the 'Add Workflow Function' form where user can choose between available workflow functions to add to the transition.
WorkflowTransition	goToAddWorkflowValidator() Go to the 'Add Workflow Validator' form where user can choose among available workflow validators to add to the transition.
boolean	isTabOpen(WorkflowTransition.Tabs tab) Check if given tab is currently open
WorkflowTransition	openTab(WorkflowTransition.Tabs tab) Open given tab.

Method Detail

goToAddWorkflowCondition

WorkflowTransition goToAddWorkflowCondition()

Go to the 'Add Workflow Condition' form where user can choose between available workflow conditions to add to the transition.

Returns:

this workflow transition

canAddWorkflowCondition

boolean canAddWorkflowCondition(String workflowConditionKey)

Check if condition with given workflowConditionKey can be added to this transition, i.e. is present on the 'Add Workflow Condition' screen

Parameters:

workflowConditionKey - key of the condition to check

Returns:

true, if condition can be added to this transition

addWorkflowCondition

WorkflowTransition addWorkflowCondition(String workflowConditionKey)

Add workflow condition with given workflowConditionKey to the transition.

For non-configurable conditions only, otherwise use addWorkflowCondition(String, java.util.Map).

Parameters:

workflowConditionKey - full plugin key of the workflow condition to add

Returns:

this workflow transition

addWorkflowCondition

WorkflowTransition addWorkflowCondition(String workflowConditionKey,
                                        Map<String,String> configFormParams)

Add workflow condition with given workflowConditionKey to the transition.

Use configFormParams to provide parameters for the custom condition configuration form.

Parameters:

workflowConditionKey - full plugin key of the workflow condition to add

configFormParams - form parameters to fill the configure condition screen

Returns:

this workflow transition

goToAddWorkflowValidator

WorkflowTransition goToAddWorkflowValidator()

Go to the 'Add Workflow Validator' form where user can choose among available workflow validators to add to the transition.

Returns:

this workflow transition

canAddWorkflowValidator

boolean canAddWorkflowValidator(String workflowValidatorKey)

Check if validator with given workflowValidatorKey can be added to this transition, i.e. is present on the 'Add Workflow Validator' screen

Parameters:

workflowValidatorKey - key of the validator to check

Returns:

true, if condition can be added to this transition

addWorkflowValidator

WorkflowTransition addWorkflowValidator(String workflowValidatorKey)

Add workflow validator with given workflowValidatorKey to the transition.

For non-configurable validators only, otherwise use addWorkflowValidator(String, java.util.Map).

Parameters:

workflowValidatorKey - full plugin key of the workflow validator to add

Returns:

this workflow transition

addWorkflowValidator

WorkflowTransition addWorkflowValidator(String workflowValidatorKey,
                                        Map<String,String> configFormParams)

Add workflow validator with given workflowValidatorKey to the transition.

Use configFormParams to provide parameters for the custom validator configuration form.

Parameters:

workflowValidatorKey - full plugin key of the workflow validator to add

configFormParams - form parameters to fill the configure validator screen

Returns:

this workflow transition

canAddWorkflowFunction

boolean canAddWorkflowFunction(String workflowFunctionKey)

Check if function with given workflowFunctionKey can be added to this transition, i.e. is present on the 'Add Workflow Function' screen

Parameters:

workflowFunctionKey - key of the function to check

Returns:

true, if condition can be added to this transition

goToAddWorkflowFunction

WorkflowTransition goToAddWorkflowFunction()

Go to the 'Add Workflow Function' form where user can choose between available workflow functions to add to the transition.

Returns:

this workflow transition

addWorkflowFunction

WorkflowTransition addWorkflowFunction(String workflowFunctionKey)

Add workflow function with given workflowFunctionKey to the transition.

This is to use for workflow functions that do not define any configuration screen, i.e. after submitting the function type there is no function-specific configuration screen. Otherwise use addWorkflowFunction(String, java.util.Map).

Parameters:

workflowFunctionKey - full plugin key of the workflow function to add

Returns:

this workflow transition

addWorkflowFunction

WorkflowTransition addWorkflowFunction(String workflowFunctionKey,
                                       Map<String,String> configFormParams)

Add workflow function with given workflowFunctionKey to the transition.

This is to use in case where the function has custom configuration screen. Pass the custom parameter values (by HTML filed name) in the configFormParams map. Otherwise use addWorkflowFunction(String) instead, or pass empty map.

Parameters:

workflowFunctionKey - full plugin key of the workflow function to add

configFormParams - form parameters to fill the configure function screen

Returns:

this workflow transition

isTabOpen

boolean isTabOpen(WorkflowTransition.Tabs tab)

Check if given tab is currently open

Parameters:

tab - tab to check

Returns:

true, if given tab is currently open

openTab

WorkflowTransition openTab(WorkflowTransition.Tabs tab)

Open given tab.

Parameters:

tab - tab to open

Returns:

this workflow transition instance