JqlFunctionModuleDescriptor

Class Overview

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. The list element specifies whether this function returns a list of values or a single value. If omitted, the default is false.

Summary

Public Methods
String	getFunctionName()
boolean	isList()

[Expand] Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor String getHtml(String resourceName, Map<String, ?> startingParams) String getHtml(String resourceName) I18nHelper getI18nBean() void writeHtml(String resourceName, Map<String, ?> startingParams, Writer writer)
From interface com.atlassian.plugin.ModuleDescriptor void destroy() void destroy(Plugin arg0) boolean equals(Object arg0) String getCompleteKey() String getDescription() String getDescriptionKey() String getI18nNameKey() String getKey() Float getMinJavaVersion() T getModule() Class<T> getModuleClass() String getName() Map<String, String> getParams() Plugin getPlugin() String getPluginKey() int hashCode() void init(Plugin arg0, Element arg1) boolean isEnabledByDefault() boolean isSystemModule() boolean satisfiesMinJavaVersion()
From interface com.atlassian.plugin.Resourced ResourceDescriptor getResourceDescriptor(String arg0, String arg1) @Deprecated List<ResourceDescriptor> getResourceDescriptors(String arg0) List<ResourceDescriptor> getResourceDescriptors() ResourceLocation getResourceLocation(String arg0, String arg1)