|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
public abstract class AbstractWorkflowPluginFactory
A base WorkflowPluginFactory
class that most concrete implementations should extend.
A WorkflowPluginFactory mainly exists to provide velocity parameters to the templates.
WorkflowPluginFactory implements methods used to configure a workflow plugin.
Generally there will be a WorkflowPluginFactory implementation for each workflow plugin type.
Constructor Summary | |
---|---|
AbstractWorkflowPluginFactory()
|
Method Summary | |
---|---|
protected Map |
createMap(Map extractedParams)
|
protected Map |
extractMultipleParams(Map params,
Collection paramNames)
|
protected String |
extractSingleParam(Map conditionParams,
String paramName)
|
Map |
getVelocityParams(String resourceName,
com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
Creates a Map of parameters for a view-specific velocity context given the name of the resource (i.e. |
protected abstract void |
getVelocityParamsForEdit(Map velocityParams,
com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'edit-parameters' velocity template. |
protected abstract void |
getVelocityParamsForInput(Map velocityParams)
Get velocity parameters for 'input-parameters' velocity template. |
protected abstract void |
getVelocityParamsForView(Map velocityParams,
com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'view' velocity template. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.atlassian.jira.plugin.workflow.WorkflowPluginFactory |
---|
getDescriptorParams |
Constructor Detail |
---|
public AbstractWorkflowPluginFactory()
Method Detail |
---|
public Map getVelocityParams(String resourceName, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
getVelocityParams
in interface WorkflowPluginFactory
resourceName
- the name of the velocitydescriptor
-
protected abstract void getVelocityParamsForInput(Map velocityParams)
velocityParams
- Map to populate.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)
protected abstract void getVelocityParamsForEdit(Map velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
descriptor.getArgs()
to retrieve the current configuration, and populate velocityParams from that.
velocityParams
- Map to populate.descriptor
- Eg. FunctionDescriptor
or ConditionDescriptor
describing the function/condition and its current configuration.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)
protected abstract void getVelocityParamsForView(Map velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
descriptor.getArgs()
to retrieve the current
configuration, look up a displayable string for the value and and populate velocityParams with that.
velocityParams
- Map to populate.descriptor
- Eg. a FunctionDescriptor
or ConditionDescriptor
describing the function/condition and its current configuration.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)
protected Map extractMultipleParams(Map params, Collection paramNames)
protected String extractSingleParam(Map conditionParams, String paramName)
protected Map createMap(Map extractedParams)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |