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 abstract 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. 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

moduleClass, moduleClassName, plugin, resources, singleton

Constructor Summary

JqlFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

abstract String	getFunctionName()
abstract boolean	isList()

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

assertResourceExists, createModule, createVelocityParams, disabled, enabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, init, isResourceExist

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

assertModuleClassImplements, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, 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

Constructor Detail

JqlFunctionModuleDescriptor

public JqlFunctionModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                   com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

getFunctionName

public abstract String getFunctionName()

isList

public abstract boolean isList()