com.atlassian.jira.plugin.workflow
Class AbstractWorkflowModuleDescriptor<T>

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
          extended by com.atlassian.jira.plugin.workflow.AbstractWorkflowModuleDescriptor<T>
All Implemented Interfaces:
JiraResourcedModuleDescriptor<T>, com.atlassian.plugin.ModuleDescriptor<T>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, Comparable<AbstractWorkflowModuleDescriptor<T>>
Direct Known Subclasses:
WorkflowConditionModuleDescriptor, WorkflowFunctionModuleDescriptor, WorkflowValidatorModuleDescriptor

public abstract class AbstractWorkflowModuleDescriptor<T>
extends AbstractJiraModuleDescriptor<T>
implements Comparable<AbstractWorkflowModuleDescriptor<T>>


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton
 
Constructor Summary
AbstractWorkflowModuleDescriptor(JiraAuthenticationContext authenticationContext, OSWorkflowConfigurator workflowConfigurator, ComponentClassManager componentClassManager, com.atlassian.plugin.module.ModuleFactory moduleFactory)
           
 
Method Summary
 int compareTo(AbstractWorkflowModuleDescriptor<T> o)
           
 void disabled()
           
 void enabled()
           
abstract  String getHtml(String resourceName, com.opensymphony.workflow.loader.AbstractDescriptor descriptor)
          Get rendered HTML from a resource defined in the plugin descriptor.
 Class<T> getImplementationClass()
           
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.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, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, 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, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 

Constructor Detail

AbstractWorkflowModuleDescriptor

public AbstractWorkflowModuleDescriptor(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<T>
Overrides:
init in class AbstractJiraModuleDescriptor<T>
Throws:
com.atlassian.plugin.PluginParseException

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class AbstractJiraModuleDescriptor<T>

disabled

public void disabled()
Specified by:
disabled in interface com.atlassian.plugin.StateAware
Overrides:
disabled in class AbstractJiraModuleDescriptor<T>

getParameterName

protected abstract String getParameterName()

getParamValue

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

getImplementationClass

public Class<T> getImplementationClass()

compareTo

public int compareTo(AbstractWorkflowModuleDescriptor<T> o)
Specified by:
compareTo in interface Comparable<AbstractWorkflowModuleDescriptor<T>>

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()


Copyright © 2002-2014 Atlassian. All Rights Reserved.