com.atlassian.jira.plugin.workflow
Class AbstractWorkflowModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          com.atlassian.jira.plugin.workflow.AbstractWorkflowModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, Comparable

Direct Known Subclasses:

WorkflowConditionModuleDescriptor, WorkflowFunctionModuleDescriptor, WorkflowValidatorModuleDescriptor

public abstract class AbstractWorkflowModuleDescriptor
extends JiraResourcedModuleDescriptor
implements Comparable

Field Summary

Fields inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

RESOURCE_TYPE_I18N

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

plugin, resources, singleton

Constructor Summary

AbstractWorkflowModuleDescriptor(JiraAuthenticationContext authenticationContext)

Method Summary

int	compareTo(Object o)
abstract String	getHtml(String resourceName, com.opensymphony.workflow.loader.AbstractDescriptor descriptor) Get rendered HTML from a resource defined in the plugin descriptor.
Class	getImplementationClass()
Object	getModule()
protected abstract String	getParameterName()
protected String	getParamValue(org.dom4j.Element element, String paramName)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
abstract boolean	isAddable(String actionType)
abstract boolean	isDeletable()
boolean	isEditable()
abstract boolean	isOrderable()
abstract boolean	isUnique()

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

assertResourceExists, createVelocityParams, getAuthenticationContext, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getName, getText, getText, isResourceExist

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

assertModuleClassImplements, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractWorkflowModuleDescriptor

public AbstractWorkflowModuleDescriptor(JiraAuthenticationContext authenticationContext)

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

Overrides:

init in class JiraResourcedModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getParameterName

protected abstract String getParameterName()

getParamValue

protected String getParamValue(org.dom4j.Element element,
                               String paramName)

getModule

public Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

getImplementationClass

public Class getImplementationClass()

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

getHtml

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

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

Parameters:

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

descriptor - ??

Returns:

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

isOrderable

public abstract boolean isOrderable()

isUnique

public abstract boolean isUnique()

isDeletable

public abstract boolean isDeletable()

isAddable

public abstract boolean isAddable(String actionType)

isEditable

public boolean isEditable()