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

All Superinterfaces:
JiraResourcedModuleDescriptor<JqlFunction>, com.atlassian.plugin.ModuleDescriptor<JqlFunction>, com.atlassian.plugin.Resourced
All Known Implementing Classes:
JqlFunctionModuleDescriptorImpl

public interface 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

Method Summary
 String getFunctionName()
           
 boolean isList()
           
 
Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
getHtml, getHtml, getI18nBean
 
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 

Method Detail

getFunctionName

String getFunctionName()

isList

boolean isList()


Copyright © 2002-2012 Atlassian. All Rights Reserved.