|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowTransition
Represents functionality of the workflow transition configuration page.
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 |
---|
WorkflowTransition goToAddWorkflowCondition()
boolean canAddWorkflowCondition(String workflowConditionKey)
workflowConditionKey
- key of the condition to check
true
, if condition can be added to this transitionWorkflowTransition addWorkflowCondition(String workflowConditionKey)
Add workflow condition with given workflowConditionKey to the transition.
For non-configurable conditions only, otherwise use addWorkflowCondition(String, java.util.Map)
.
workflowConditionKey
- full plugin key of the workflow condition to add
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.
workflowConditionKey
- full plugin key of the workflow condition to addconfigFormParams
- form parameters to fill the configure condition screen
WorkflowTransition goToAddWorkflowValidator()
boolean canAddWorkflowValidator(String workflowValidatorKey)
workflowValidatorKey
- key of the validator to check
true
, if condition can be added to this transitionWorkflowTransition addWorkflowValidator(String workflowValidatorKey)
Add workflow validator with given workflowValidatorKey to the transition.
For non-configurable validators only, otherwise use addWorkflowValidator(String, java.util.Map)
.
workflowValidatorKey
- full plugin key of the workflow validator to add
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.
workflowValidatorKey
- full plugin key of the workflow validator to addconfigFormParams
- form parameters to fill the configure validator screen
boolean canAddWorkflowFunction(String workflowFunctionKey)
workflowFunctionKey
- key of the function to check
true
, if condition can be added to this transitionWorkflowTransition goToAddWorkflowFunction()
Go to the 'Add Workflow Function' form where user can choose between available workflow functions to add to the transition.
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)
.
workflowFunctionKey
- full plugin key of the workflow function to add
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.
workflowFunctionKey
- full plugin key of the workflow function to addconfigFormParams
- form parameters to fill the configure function screen
boolean isTabOpen(WorkflowTransition.Tabs tab)
tab
- tab to check
true
, if given tab is currently openWorkflowTransition openTab(WorkflowTransition.Tabs tab)
tab
- tab to open
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |