public abstract class

AbstractWorkflowPermissionPluginFactory

extends AbstractWorkflowPluginFactory
java.lang.Object
   ↳ com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
     ↳ com.atlassian.jira.plugin.workflow.AbstractWorkflowPermissionPluginFactory
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A common base class for Workflow Plugin Factories that are concerned with Permissions.

Summary

Protected Constructors
AbstractWorkflowPermissionPluginFactory(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager)
Public Methods
Map<String, ?> getDescriptorParams(Map<StringObject> params)
Protected Methods
void clearLegacyPermissionArgument(Map<?, ?> descriptorArgs)
abstract Map<?, ?> extractArgs(AbstractDescriptor descriptor)
void getVelocityParamsForEdit(Map<StringObject> velocityParams, AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'edit-parameters' velocity template.
void getVelocityParamsForInput(Map<StringObject> velocityParams)
Get velocity parameters for 'input-parameters' velocity template.
void getVelocityParamsForView(Map<StringObject> velocityParams, AbstractDescriptor descriptor)
Populates the given map with velocity parameters for 'view' velocity template.
void populateTemplateParamsForInputAndEdit(Map<StringObject> velocityParams, Map<?, ?> descriptorArgs)
void populateTemplateParamsForView(Map<StringObject> velocityParams, Map<?, ?> descriptorArgs)
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.workflow.AbstractWorkflowPluginFactory
From class java.lang.Object
From interface com.atlassian.jira.plugin.workflow.WorkflowPluginFactory

Protected Constructors

protected AbstractWorkflowPermissionPluginFactory (JiraAuthenticationContext authenticationContext, PermissionManager permissionManager)

Public Methods

public Map<String, ?> getDescriptorParams (Map<StringObject> params)

Protected Methods

protected void clearLegacyPermissionArgument (Map<?, ?> descriptorArgs)

protected abstract Map<?, ?> extractArgs (AbstractDescriptor descriptor)

protected void getVelocityParamsForEdit (Map<StringObject> 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<StringObject> velocityParams)

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

Parameters
velocityParams Map to populate.

protected void getVelocityParamsForView (Map<StringObject> 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.

protected void populateTemplateParamsForInputAndEdit (Map<StringObject> velocityParams, Map<?, ?> descriptorArgs)

protected void populateTemplateParamsForView (Map<StringObject> velocityParams, Map<?, ?> descriptorArgs)