com.atlassian.jira.plugin.customfield
Class CustomFieldTypeModuleDescriptorImpl

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<CustomFieldType>
          extended by com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptorImpl
All Implemented Interfaces:
CustomFieldTypeModuleDescriptor, JiraResourcedModuleDescriptor<CustomFieldType>, com.atlassian.plugin.ModuleDescriptor<CustomFieldType>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class CustomFieldTypeModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<CustomFieldType>
implements CustomFieldTypeModuleDescriptor


Field Summary
 
Fields inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
RESOURCE_TYPE_I18N
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
moduleClass, moduleClassName, plugin, resources, singleton
 
Fields inherited from interface com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptor
MANAGED_DESC, MANAGED_FLAG, TEMPLATE_NAME_BULK_MOVE, TEMPLATE_NAME_COLUMN, TEMPLATE_NAME_EDIT, TEMPLATE_NAME_EDIT_DEFAULT, TEMPLATE_NAME_VIEW, TEMPLATE_NAME_XML, VELCITY_ACTION_PARAM, VELOCITY_VALUE_PARAM
 
Constructor Summary
CustomFieldTypeModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, RendererManager rendererManager, com.atlassian.plugin.module.ModuleFactory moduleFactory, CustomFieldDefaultVelocityParams customFieldDefaultVelocityParams)
           
 
Method Summary
 void enabled()
           
 String getBulkMoveHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem, Map<Long,BulkMoveHelper.DistinctValueResult> distinctValues, BulkMoveHelper bulkMoveHelper)
           
 String getColumnViewHtml(CustomField field, Object value, Issue issue, Map displayParams, FieldLayoutItem fieldLayoutItem)
           
 String getDefaultViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
           
 String getEditDefaultHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
           
 String getEditHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
           
 String getHtml(String resourceName, Map<String,?> startingParams)
           
 ConfigurationItemAccessLevel getManagedAccessLevel()
           
 String getManagedDescriptionKey()
           
 Set<String> getValidSearcherKeys()
          Returns the list of Searchers that this CustomFieldType declares as usable to search itself.
 String getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem)
           
 String getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem, Map displayParameters)
           
 String getViewXML(CustomField field, Issue issue, FieldLayoutItem fieldLayoutItem, boolean raw)
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 boolean isColumnViewTemplateExists()
           
 boolean isEditTemplateExists()
           
 boolean isTypeManaged()
          Is this custom field type a "managed" type? The provider of this type may want to control the circumstances in which it is used.
 boolean isViewTemplateExists()
           
 boolean isXMLTemplateExists()
           
 
Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getI18nBean, getModule, getName, getText, getText, 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
 
Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
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, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 

Constructor Detail

CustomFieldTypeModuleDescriptorImpl

public CustomFieldTypeModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                           RendererManager rendererManager,
                                           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<CustomFieldType>
Overrides:
init in class AbstractJiraModuleDescriptor<CustomFieldType>
Throws:
com.atlassian.plugin.PluginParseException

getValidSearcherKeys

public Set<String> getValidSearcherKeys()
Description copied from interface: CustomFieldTypeModuleDescriptor
Returns the list of Searchers that this CustomFieldType declares as usable to search itself.

Note that it is also possible for a CustomFieldSearcher to declare a CustomFieldType that it is able to search on.

Specified by:
getValidSearcherKeys in interface CustomFieldTypeModuleDescriptor
Returns:
the list of Searchers that this CustomFieldType declares as usable to search itself.

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class AbstractJiraModuleDescriptor<CustomFieldType>

isViewTemplateExists

public boolean isViewTemplateExists()
Specified by:
isViewTemplateExists in interface CustomFieldTypeModuleDescriptor

isColumnViewTemplateExists

public boolean isColumnViewTemplateExists()
Specified by:
isColumnViewTemplateExists in interface CustomFieldTypeModuleDescriptor

isEditTemplateExists

public boolean isEditTemplateExists()
Specified by:
isEditTemplateExists in interface CustomFieldTypeModuleDescriptor

isXMLTemplateExists

public boolean isXMLTemplateExists()
Specified by:
isXMLTemplateExists in interface CustomFieldTypeModuleDescriptor

isTypeManaged

public boolean isTypeManaged()
Description copied from interface: CustomFieldTypeModuleDescriptor
Is this custom field type a "managed" type? The provider of this type may want to control the circumstances in which it is used.

Specified by:
isTypeManaged in interface CustomFieldTypeModuleDescriptor
Returns:
boolean

getManagedAccessLevel

@Nullable
public ConfigurationItemAccessLevel getManagedAccessLevel()
Specified by:
getManagedAccessLevel in interface CustomFieldTypeModuleDescriptor
Returns:
the level which the user has to be to be able to create new instances of this custom field type; may return null if level was not specified or was specified incorrectly

getManagedDescriptionKey

public String getManagedDescriptionKey()
Specified by:
getManagedDescriptionKey in interface CustomFieldTypeModuleDescriptor
Returns:
the I18n key of the description explaining the reason this type is managed.

getEditHtml

public String getEditHtml(FieldConfig config,
                          Map customFieldValuesHolder,
                          Issue issue,
                          webwork.action.Action action,
                          Map displayParameters,
                          FieldLayoutItem fieldLayoutItem)
Specified by:
getEditHtml in interface CustomFieldTypeModuleDescriptor

getBulkMoveHtml

public String getBulkMoveHtml(FieldConfig config,
                              Map customFieldValuesHolder,
                              Issue issue,
                              webwork.action.Action action,
                              Map displayParameters,
                              FieldLayoutItem fieldLayoutItem,
                              Map<Long,BulkMoveHelper.DistinctValueResult> distinctValues,
                              BulkMoveHelper bulkMoveHelper)
Specified by:
getBulkMoveHtml in interface CustomFieldTypeModuleDescriptor

getEditDefaultHtml

public String getEditDefaultHtml(FieldConfig config,
                                 Map customFieldValuesHolder,
                                 Issue issue,
                                 webwork.action.Action action,
                                 Map displayParameters,
                                 FieldLayoutItem fieldLayoutItem)
Specified by:
getEditDefaultHtml in interface CustomFieldTypeModuleDescriptor

getColumnViewHtml

public String getColumnViewHtml(CustomField field,
                                Object value,
                                Issue issue,
                                Map displayParams,
                                FieldLayoutItem fieldLayoutItem)
Specified by:
getColumnViewHtml in interface CustomFieldTypeModuleDescriptor

getViewHtml

public String getViewHtml(CustomField field,
                          Object value,
                          Issue issue,
                          FieldLayoutItem fieldLayoutItem)
Specified by:
getViewHtml in interface CustomFieldTypeModuleDescriptor

getViewHtml

public String getViewHtml(CustomField field,
                          Object value,
                          Issue issue,
                          FieldLayoutItem fieldLayoutItem,
                          Map displayParameters)
Specified by:
getViewHtml in interface CustomFieldTypeModuleDescriptor

getViewXML

public String getViewXML(CustomField field,
                         Issue issue,
                         FieldLayoutItem fieldLayoutItem,
                         boolean raw)
Specified by:
getViewXML in interface CustomFieldTypeModuleDescriptor

getDefaultViewHtml

public String getDefaultViewHtml(FieldConfig fieldConfig,
                                 FieldLayoutItem fieldLayoutItem)
Specified by:
getDefaultViewHtml in interface CustomFieldTypeModuleDescriptor

getHtml

public String getHtml(String resourceName,
                      Map<String,?> startingParams)
Specified by:
getHtml in interface JiraResourcedModuleDescriptor<CustomFieldType>
Overrides:
getHtml in class AbstractJiraModuleDescriptor<CustomFieldType>


Copyright © 2002-2013 Atlassian. All Rights Reserved.