@PublicApi public interface

CustomFieldTypeModuleDescriptor

implements JiraResourcedModuleDescriptor<T>
com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptor
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

Constants
String MANAGED_DESC
String MANAGED_FLAG The name of the attribute to specify for a custom field type when you want new instances of this custom field type to only be created by certain users.
String TEMPLATE_NAME_BULK_MOVE
String TEMPLATE_NAME_COLUMN
String TEMPLATE_NAME_EDIT
String TEMPLATE_NAME_EDIT_DEFAULT
String TEMPLATE_NAME_VIEW
String TEMPLATE_NAME_XML
String VELCITY_ACTION_PARAM
String VELOCITY_VALUE_PARAM
Public Methods
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)
@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)
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 interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced

Constants

public static final String MANAGED_DESC

Constant Value: "managed-description-key"

public static final String MANAGED_FLAG

The name of the attribute to specify for a custom field type when you want new instances of this custom field type to only be created by certain users. The values of this attribute are the string versions of ConfigurationItemAccessLevel.

Constant Value: "managed-access-level"

public static final String TEMPLATE_NAME_BULK_MOVE

Constant Value: "bulk-move"

public static final String TEMPLATE_NAME_COLUMN

Constant Value: "column-view"

public static final String TEMPLATE_NAME_EDIT

Constant Value: "edit"

public static final String TEMPLATE_NAME_EDIT_DEFAULT

Constant Value: "edit-default"

public static final String TEMPLATE_NAME_VIEW

Constant Value: "view"

public static final String TEMPLATE_NAME_XML

Constant Value: "xml"

public static final String VELCITY_ACTION_PARAM

Constant Value: "action"

public static final String VELOCITY_VALUE_PARAM

Constant Value: "value"

Public Methods

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)

@Nullable public ConfigurationItemAccessLevel getManagedAccessLevel ()

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

public String getManagedDescriptionKey ()

Returns
  • the I18n key of the description explaining the reason this type is managed.

public Map<Integer, CustomFieldRestSerializer> getRestSerializers ()

Returns
  • the map of CustomFieldRestSerializers which serialize customfield to its another json representation. Keys of the returned map are names of these alternative representations.

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 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 ()