public class

ReferenceWorkflowModuleFactory

extends AbstractWorkflowPluginFactory
implements WorkflowPluginConditionFactory WorkflowPluginValidatorFactory
java.lang.Object
   ↳ com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
     ↳ com.atlassian.jira.dev.reference.plugin.workflow.ReferenceWorkflowModuleFactory

Summary

Public Constructors
ReferenceWorkflowModuleFactory()
Public Methods
Map<String, Object> getDescriptorParams(Map<String, Object> conditionParams)
Given a set of name:value parameters from the plugin configuration page (ie.
Protected Methods
void getVelocityParamsForEdit(Map<String, Object> velocityParams, AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'edit-parameters' velocity template.
void getVelocityParamsForInput(Map<String, Object> velocityParams)
Get velocity parameters for 'input-parameters' velocity template.
void getVelocityParamsForView(Map<String, Object> velocityParams, AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'view' velocity template.
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
From class java.lang.Object
From interface com.atlassian.jira.plugin.workflow.WorkflowPluginFactory

Public Constructors

public ReferenceWorkflowModuleFactory ()

Public Methods

public Map<String, Object> getDescriptorParams (Map<String, Object> conditionParams)

Given a set of name:value parameters from the plugin configuration page (ie. the 'input-parameters' velocity template) return a map of sanitized parameters which will be passed into workflow plugin instances. For example, the results are passed in the 'arg' parameter of post-functions' execute() or conditions' passesCondition methods. The velocity page often submits values in array form, and this method extracts just the relevant value.

Parameters
conditionParams Parameters from the velocity template, eg. {"fieldId" : ["assignee"], "fieldValue":["-1"]}
Returns
  • Parameters to be passed into workflow functions via the 'args' map. Eg. {"assignee": "-1"}

Protected Methods

protected void getVelocityParamsForEdit (Map<String, Object> velocityParams, AbstractDescriptor descriptor)

Populates the given map with velocity parameters for 'edit-parameters' velocity template. Typically an implementation would call descriptor.getArgs() to retrieve the current configuration, and populate velocityParams from that.

Parameters
velocityParams Map to populate.
descriptor Eg. FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.

protected void getVelocityParamsForInput (Map<String, Object> velocityParams)

Get velocity parameters for 'input-parameters' velocity template.

Parameters
velocityParams Map to populate.

protected void getVelocityParamsForView (Map<String, Object> velocityParams, AbstractDescriptor descriptor)

Populates the given map with velocity parameters for 'view' velocity template. Eg. call descriptor.getArgs() to retrieve the current configuration, look up a displayable string for the value and and populate velocityParams with that.

Parameters
velocityParams Map to populate.
descriptor Eg. a FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.