com.atlassian.jira.plugin.workflow
Class WorkflowPermissionConditionFactoryImpl

java.lang.Object
  extended by com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
      extended by com.atlassian.jira.plugin.workflow.AbstractWorkflowPermissionPluginFactory
          extended by com.atlassian.jira.plugin.workflow.WorkflowPermissionConditionFactoryImpl
All Implemented Interfaces:
WorkflowPluginConditionFactory, WorkflowPluginFactory

public class WorkflowPermissionConditionFactoryImpl
extends AbstractWorkflowPermissionPluginFactory
implements WorkflowPluginConditionFactory


Constructor Summary
WorkflowPermissionConditionFactoryImpl(SchemePermissions schemePermissions)
           
 
Method Summary
 java.util.Map getDescriptorParams(java.util.Map conditionParams)
          Given a set of name:value parameters from the plugin configuration page (ie.
protected  void getVelocityParamsForEdit(java.util.Map velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
          Populates the given map with velocity parameters for 'edit-parameters' velocity template.
protected  void getVelocityParamsForView(java.util.Map velocityParams, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
          Populates the given map with velocity parameters for 'view' velocity template.
 
Methods inherited from class com.atlassian.jira.plugin.workflow.AbstractWorkflowPermissionPluginFactory
getGroupedPermissions, getVelocityParamsForInput
 
Methods inherited from class com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
createMap, extractMultipleParams, extractSingleParam, getVelocityParams
 
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
getVelocityParams
 

Constructor Detail

WorkflowPermissionConditionFactoryImpl

public WorkflowPermissionConditionFactoryImpl(SchemePermissions schemePermissions)
Method Detail

getVelocityParamsForEdit

protected void getVelocityParamsForEdit(java.util.Map velocityParams,
                                        com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
Description copied from class: AbstractWorkflowPluginFactory
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.

Specified by:
getVelocityParamsForEdit in class AbstractWorkflowPluginFactory
Parameters:
velocityParams - Map to populate.
descriptor - Eg. FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.
See Also:
AbstractWorkflowPluginFactory.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)

getVelocityParamsForView

protected void getVelocityParamsForView(java.util.Map velocityParams,
                                        com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
Description copied from class: AbstractWorkflowPluginFactory
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.

Specified by:
getVelocityParamsForView in class AbstractWorkflowPluginFactory
Parameters:
velocityParams - Map to populate.
descriptor - Eg. a FunctionDescriptor or ConditionDescriptor describing the function/condition and its current configuration.
See Also:
AbstractWorkflowPluginFactory.getVelocityParams(String, com.opensymphony.workflow.loader.AbstractDescriptor)

getDescriptorParams

public java.util.Map getDescriptorParams(java.util.Map conditionParams)
Description copied from interface: WorkflowPluginFactory
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.

Specified by:
getDescriptorParams in interface WorkflowPluginFactory
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"}


Copyright © 2002-2010 Atlassian. All Rights Reserved.