com.atlassian.jira.plugin.jql.function
Class JqlFunctionModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<JqlFunction>
          com.atlassian.jira.plugin.jql.function.JqlFunctionModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<JqlFunction>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class JqlFunctionModuleDescriptor
extends JiraResourcedModuleDescriptor<JqlFunction>

A module descriptor for a JQL function handler that produces a JqlFunction. The following is an example XML descriptor for a JQL function:

 <jql-function key="now-jql-function"
          i18n-name-key="jql.function.plugin.now.name"
          name="Now Function"
          class="com.atlassian.jira.plugin.jql.function.NowFunction"
          >
      <description key="jql.function.plugin.now.desc">Returns the current system time.</description>
      <fname>now</fname>
      <list>false</list>
 </jql-function>

 

The fname element specifies the name of the function - this element is mandatory and cannot be blank. The list element specifies whether this function returns a list of values or a single value. If omitted, the default is false.

Since:

v4.0

Field Summary

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

RESOURCE_TYPE_I18N

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

moduleClassName, plugin, resources, singleton

Constructor Summary

JqlFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext, JqlFunctionHandlerRegistry functionRegistry)

Method Summary

void	disabled()
void	enabled()
String	getFunctionName()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isList()

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

assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getModule, 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, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JqlFunctionModuleDescriptor

public JqlFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                   JqlFunctionHandlerRegistry functionRegistry)

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<JqlFunction>

Overrides:

init in class JiraResourcedModuleDescriptor<JqlFunction>

Throws:

com.atlassian.plugin.PluginParseException

getFunctionName

public String getFunctionName()

isList

public boolean isList()

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<JqlFunction>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class JiraResourcedModuleDescriptor<JqlFunction>