com.atlassian.jira.plugin.customfield

Class CustomFieldSearcherModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<CustomFieldSearcher>

com.atlassian.jira.plugin.customfield.CustomFieldSearcherModuleDescriptorImpl

All Implemented Interfaces:

CustomFieldSearcherModuleDescriptor, JiraResourcedModuleDescriptor<CustomFieldSearcher>, com.atlassian.plugin.ModuleDescriptor<CustomFieldSearcher>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class CustomFieldSearcherModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<CustomFieldSearcher>
implements CustomFieldSearcherModuleDescriptor

Field Summary

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

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description
CustomFieldSearcherModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory, CustomFieldDefaultVelocityParams customFieldDefaultVelocityParams)

Method Summary

Modifier and Type	Method and Description
void	enabled()
String	getHtml(String resourceName, Map<String,?> startingParams)
CustomFieldSearcher	getModule()
String	getSearchHtml(CustomField customField, CustomFieldValueProvider provider, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action, Map velocityParams)
String	getStatHtml(CustomField field, Object value, String urlPrefix)
Set	getValidCustomFieldKeys()
String	getViewHtml(CustomField customField, CustomFieldValueProvider provider, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action, Map velocityParams)
String	getViewHtml(CustomField field, Object value)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getI18nBean, getName, getText, getText, isResourceExist, writeHtml

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

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Constructor Detail

CustomFieldSearcherModuleDescriptorImpl

public CustomFieldSearcherModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                               com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                               CustomFieldDefaultVelocityParams customFieldDefaultVelocityParams)

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

Overrides:

init in class AbstractJiraModuleDescriptor<CustomFieldSearcher>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractJiraModuleDescriptor<CustomFieldSearcher>

getSearchHtml

public String getSearchHtml(CustomField customField,
                            CustomFieldValueProvider provider,
                            SearchContext searchContext,
                            FieldValuesHolder fieldValuesHolder,
                            Map displayParameters,
                            webwork.action.Action action,
                            Map velocityParams)

Specified by:

getSearchHtml in interface CustomFieldSearcherModuleDescriptor

getViewHtml

public String getViewHtml(CustomField customField,
                          CustomFieldValueProvider provider,
                          SearchContext searchContext,
                          FieldValuesHolder fieldValuesHolder,
                          Map displayParameters,
                          webwork.action.Action action,
                          Map velocityParams)

Specified by:

getViewHtml in interface CustomFieldSearcherModuleDescriptor

getViewHtml

public String getViewHtml(CustomField field,
                          Object value)

Specified by:

getViewHtml in interface CustomFieldSearcherModuleDescriptor

getStatHtml

public String getStatHtml(CustomField field,
                          Object value,
                          String urlPrefix)

Specified by:

getStatHtml in interface CustomFieldSearcherModuleDescriptor

getValidCustomFieldKeys

public Set getValidCustomFieldKeys()

Specified by:

getValidCustomFieldKeys in interface CustomFieldSearcherModuleDescriptor

getHtml

public String getHtml(String resourceName,
                      Map<String,?> startingParams)

Specified by:

getHtml in interface JiraResourcedModuleDescriptor<CustomFieldSearcher>

Overrides:

getHtml in class AbstractJiraModuleDescriptor<CustomFieldSearcher>

getModule

public CustomFieldSearcher getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<CustomFieldSearcher>

Overrides:

getModule in class AbstractJiraModuleDescriptor<CustomFieldSearcher>