public class

CustomFieldTypeModuleDescriptorImpl

extends AbstractJiraModuleDescriptor<T>
implements CustomFieldTypeModuleDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
       ↳ com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptorImpl

Summary

Constants
String REST_SERIALIZER_ELEMENT_NAME
String SERIALIZER_CLASS_ARGUMENT_NAME
String VERSION_NUMBER_ARGUMENT_NAME
[Expand]
Inherited Constants
From interface com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptor
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
CustomFieldTypeModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, RendererManager rendererManager, ModuleFactory moduleFactory, CustomFieldDefaultVelocityParams customFieldDefaultVelocityParams)
Public Methods
void enabled()
String getBulkMoveHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem, Map<Long, BulkMoveHelper.DistinctValueResult> distinctValues, BulkMoveHelper bulkMoveHelper)
Set<CustomFieldTypeCategory> getCategories()
The set of categories that this CustomFieldType has declared as being a member of.
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, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
String getEditHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
String getHtml(String resourceName, Map<String, ?> startingParams)
@Nullable ConfigurationItemAccessLevel getManagedAccessLevel()
String getManagedDescriptionKey()
Map<Integer, CustomFieldRestSerializer> getRestSerializers()
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, Map displayParameters)
String getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem)
String getViewXML(CustomField field, Issue issue, FieldLayoutItem fieldLayoutItem, boolean raw)
void init(Plugin plugin, 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()
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Constants

public static final String REST_SERIALIZER_ELEMENT_NAME

Constant Value: "rest-serializer"

public static final String SERIALIZER_CLASS_ARGUMENT_NAME

Constant Value: "class"

public static final String VERSION_NUMBER_ARGUMENT_NAME

Constant Value: "version-number"

Public Constructors

public CustomFieldTypeModuleDescriptorImpl (JiraAuthenticationContext authenticationContext, RendererManager rendererManager, ModuleFactory moduleFactory, CustomFieldDefaultVelocityParams customFieldDefaultVelocityParams)

Public Methods

public void enabled ()

public String getBulkMoveHtml (FieldConfig config, Map customFieldValuesHolder, Issue issue, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem, Map<Long, BulkMoveHelper.DistinctValueResult> distinctValues, BulkMoveHelper bulkMoveHelper)

public Set<CustomFieldTypeCategory> getCategories ()

The set of categories that this CustomFieldType has declared as being a member of.

public String getColumnViewHtml (CustomField field, Object value, Issue issue, Map displayParams, FieldLayoutItem fieldLayoutItem)

public String getDefaultViewHtml (FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)

public String getEditDefaultHtml (FieldConfig config, Map customFieldValuesHolder, Issue issue, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)

public String getEditHtml (FieldConfig config, Map customFieldValuesHolder, Issue issue, Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)

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

@Nullable public ConfigurationItemAccessLevel getManagedAccessLevel ()

public String getManagedDescriptionKey ()

public Map<Integer, CustomFieldRestSerializer> getRestSerializers ()

public Set<String> getValidSearcherKeys ()

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.

Returns
  • the list of Searchers that this CustomFieldType declares as usable to search itself.

public String getViewHtml (CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem, Map displayParameters)

public String getViewHtml (CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem)

public String getViewXML (CustomField field, Issue issue, FieldLayoutItem fieldLayoutItem, boolean raw)

public void init (Plugin plugin, Element element)

Throws
PluginParseException

public boolean isColumnViewTemplateExists ()

public boolean isEditTemplateExists ()

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

Returns
  • boolean

public boolean isViewTemplateExists ()

public boolean isXMLTemplateExists ()