com.atlassian.jira.plugin.workflow

Class WorkflowFunctionModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>

com.atlassian.jira.plugin.workflow.AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

com.atlassian.jira.plugin.workflow.WorkflowFunctionModuleDescriptor

All Implemented Interfaces:

JiraResourcedModuleDescriptor<WorkflowPluginFunctionFactory>, com.atlassian.plugin.ModuleDescriptor<WorkflowPluginFunctionFactory>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>>

public class WorkflowFunctionModuleDescriptor
extends AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_TYPE_NON_INITIAL

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description
WorkflowFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext, OSWorkflowConfigurator workflowConfigurator, ComponentClassManager componentClassManager, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
String	getHtml(String resourceName, com.opensymphony.workflow.loader.AbstractDescriptor descriptor) Get rendered HTML from a resource defined in the plugin descriptor.
protected String	getParameterName()
Integer	getWeight()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isAddable(String actionType)
boolean	isDefault()
boolean	isDeletable()
boolean	isOrderable()
boolean	isUnique()

Methods inherited from class com.atlassian.jira.plugin.workflow.AbstractWorkflowModuleDescriptor

compareTo, createPluginTypeResolver, disabled, enabled, getImplementationClass, getParamValue, isEditable

Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor

assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, isResourceExist, writeHtml

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Field Detail

ACTION_TYPE_NON_INITIAL

public static final String ACTION_TYPE_NON_INITIAL

See Also:

Constant Field Values

Constructor Detail

WorkflowFunctionModuleDescriptor

public WorkflowFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                        OSWorkflowConfigurator workflowConfigurator,
                                        ComponentClassManager componentClassManager,
                                        com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<WorkflowPluginFunctionFactory>

Overrides:

init in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

Throws:

com.atlassian.plugin.PluginParseException

getParameterName

protected String getParameterName()

Specified by:

getParameterName in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

getHtml

public String getHtml(String resourceName,
                      com.opensymphony.workflow.loader.AbstractDescriptor descriptor)

Description copied from class: AbstractWorkflowModuleDescriptor

Get rendered HTML from a resource defined in the plugin descriptor.

Specified by:

getHtml in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

Parameters:

resourceName - Eg. "view" or "input-parameters"

descriptor - ??

Returns:

HTML rendered from resource (eg. velocity template or JSP)

isOrderable

public boolean isOrderable()

Specified by:

isOrderable in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

isUnique

public boolean isUnique()

Specified by:

isUnique in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

isDeletable

public boolean isDeletable()

Specified by:

isDeletable in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

isAddable

public boolean isAddable(String actionType)

Specified by:

isAddable in class AbstractWorkflowModuleDescriptor<WorkflowPluginFunctionFactory>

getWeight

public Integer getWeight()

isDefault

public boolean isDefault()