@PublicApi public interface

CustomFieldManager

com.atlassian.jira.issue.CustomFieldManager
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).

Class Overview

Functions for working with CustomFields.

Summary

Constants
String PLUGIN_KEY
Public Methods
void clear()
clear the cache
CustomField createCustomField(String fieldName, String description, CustomFieldType fieldType, CustomFieldSearcher customFieldSearcher, List contexts, List issueTypes)
Creates a custom field with the given name and description of the given CustomFieldType using the given CustomFieldSearcher that is displayed in the given list of contexts available to the given list of issueTypes.
boolean exists(String id)
Returns true if this customfield actually exists.
CustomField getCustomFieldInstance(GenericValue customFieldGv)
Converts a customfield GenericValue to a CustomField instance.
CustomField getCustomFieldObject(String id)
Get a CustomField by its text key (eg 'customfield_10000').
CustomField getCustomFieldObject(Long id)
Get a CustomField by ID.
CustomField getCustomFieldObjectByName(String customFieldName)
Retrieve the first custom field object with the specified name.
List<CustomField> getCustomFieldObjects(SearchContext searchContext)
Returns all customfields in a particular SearchContext.
List<CustomField> getCustomFieldObjects(GenericValue issue)
Returns a list of CustomFields that apply to a particular issue.
List<CustomField> getCustomFieldObjects(Long projectId, List<String> issueTypes)
Returns the same as getCustomFieldObjects(Long, String) but allows to specify a list of issueTypes.
List<CustomField> getCustomFieldObjects(Long projectId, String issueType)
Gets a list of custom fields for a particular project and issue type.
List<CustomField> getCustomFieldObjects(Issue issue)
Returns a list of CustomFields that apply to a particular issue.
List<CustomField> getCustomFieldObjects()
Returns all custom fields.
Collection<CustomField> getCustomFieldObjectsByName(String customFieldName)
Retrieve custom field(s) of a certain name.
CustomFieldSearcher getCustomFieldSearcher(String key)
Retrieve a custom field searcher by its type key.
Class<? extends CustomFieldSearcher> getCustomFieldSearcherClass(String key)
Retrieve a custom field searcher by its type key.
@Nonnull List<CustomFieldSearcher> getCustomFieldSearchers(CustomFieldType customFieldType)
Retrieves all the searchers registered for a particular custom Field.
CustomFieldType getCustomFieldType(String key)
Retrieve a custom field type by its type key.
@Nonnull List<CustomFieldType<?, ?>> getCustomFieldTypes()
Retrieve all customfieldtypes registered in the sytem.
@Nullable CustomFieldSearcher getDefaultSearcher(CustomFieldType<?, ?> type)
Return the default CustomFieldSearcher for the passed CustomFieldType.
List<CustomField> getGlobalCustomFieldObjects()
Returns a list of custom fields where the isGlobal() is true.
void refresh()
reloads all customfields into the cache from the DB, this is an expensive operation, so avoid it if you can.
void refreshConfigurationSchemes(Long customFieldId)
Causes a reload of the field configuration scheme for a specified custom field id Call when the configuration scheme changes
void removeCustomField(CustomField customField)
Removes the customfield supplied including all associations and values.
void removeCustomFieldPossiblyLeavingOrphanedData(Long customFieldId)
Removes the customfield supplied.
void removeCustomFieldValues(GenericValue issue)
Removes the values stored by customfields for a particular Issue.
void removeProjectAssociations(Project project)
Used if a project is deleted to remove the project field associations.
void removeProjectAssociations(GenericValue project)
This method is deprecated. Use removeProjectAssociations(Project) instead. Since v5.1.
void removeProjectCategoryAssociations(ProjectCategory projectCategory)
Used if a project category is deleted to remove the field associations.
void updateCustomField(CustomField updatedField)
Updates the supplied custom field, refreshes the underlying cache

Constants

public static final String PLUGIN_KEY

Constant Value: "com.atlassian.jira.plugin.system.customfieldtypes"

Public Methods

public void clear ()

clear the cache

public CustomField createCustomField (String fieldName, String description, CustomFieldType fieldType, CustomFieldSearcher customFieldSearcher, List contexts, List issueTypes)

Creates a custom field with the given name and description of the given CustomFieldType using the given CustomFieldSearcher that is displayed in the given list of contexts available to the given list of issueTypes.

Returns
  • the newly created CustomField.
Throws
GenericEntityException if the CustomField could not be created.

public boolean exists (String id)

Returns true if this customfield actually exists. This saves unnecessary copying of custom field objects when all we want to know is "does it exist"

Parameters
id Eg. 'customfield_10000'
Returns
  • true if the custom field is returned

public CustomField getCustomFieldInstance (GenericValue customFieldGv)

Converts a customfield GenericValue to a CustomField instance.

Returns

public CustomField getCustomFieldObject (String id)

Get a CustomField by its text key (eg 'customfield_10000').

Parameters
id Eg. 'customfield_10000'
Returns

public CustomField getCustomFieldObject (Long id)

Get a CustomField by ID.

Parameters
id ID of field, eg. 10000
Returns

public CustomField getCustomFieldObjectByName (String customFieldName)

Retrieve the first custom field object with the specified name. WARNING: Custom Field names are no longer guaranteed to be unique. This method returns the first named custom field. Use getCustomFieldObjectsByName(String) to retrieve all custom fields.

Parameters
customFieldName the Name
Returns

public List<CustomField> getCustomFieldObjects (SearchContext searchContext)

Returns all customfields in a particular SearchContext. Also see isInScope(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.issue.search.SearchContext).

Parameters
searchContext the SearchContext
Returns

public List<CustomField> getCustomFieldObjects (GenericValue issue)

Returns a list of CustomFields that apply to a particular issue.

Parameters
issue A GenericValue of the issue
Returns

public List<CustomField> getCustomFieldObjects (Long projectId, List<String> issueTypes)

Returns the same as getCustomFieldObjects(Long, String) but allows to specify a list of issueTypes.

Parameters
projectId Id of the project
issueTypes A list of issue types. See ALL_ISSUE_TYPES, ALL_STANDARD_ISSUE_TYPES and ALL_SUB_TASK_ISSUE_TYPES
Returns

public List<CustomField> getCustomFieldObjects (Long projectId, String issueType)

Gets a list of custom fields for a particular project and issue type.

Parameters
projectId Id of the project
issueType An issue type. See ALL_ISSUE_TYPES, ALL_STANDARD_ISSUE_TYPES and ALL_SUB_TASK_ISSUE_TYPES
Returns

public List<CustomField> getCustomFieldObjects (Issue issue)

Returns a list of CustomFields that apply to a particular issue.

Parameters
issue A Issue object
Returns

public List<CustomField> getCustomFieldObjects ()

Returns all custom fields.

Returns

public Collection<CustomField> getCustomFieldObjectsByName (String customFieldName)

Retrieve custom field(s) of a certain name.

Returns

public CustomFieldSearcher getCustomFieldSearcher (String key)

Retrieve a custom field searcher by its type key.

The key is the "full plugin module key". That is, the plugin key for the plugin it comes from, a colon separator, and then the module key. e.g. the system types are specified in system-customfieldtypes-plugin.xml: 

 <atlassian-plugin key="com.atlassian.jira.plugin.system.customfieldtypes" name="Custom Field Types & Searchers">
     ...
     <customfield-type key="float" name="Number Field"
     ...
To access the 'Number Field' type, the key would then be 'com.atlassian.jira.plugin.system.customfieldtypes:float'.

Parameters
key Type identifier constructed from plugin XML.
Returns
  • the CustomFieldSearcher for the given key

public Class<? extends CustomFieldSearcher> getCustomFieldSearcherClass (String key)

Retrieve a custom field searcher by its type key.

The key is the "full plugin module key". That is, the plugin key for the plugin it comes from, a colon separator, and then the module key. e.g. the system types are specified in system-customfieldtypes-plugin.xml: 

 <atlassian-plugin key="com.atlassian.jira.plugin.system.customfieldtypes" name="Custom Field Types & Searchers">
     ...
     <customfield-type key="float" name="Number Field"
     ...
To access the 'Number Field' type, the key would then be 'com.atlassian.jira.plugin.system.customfieldtypes:float'.

Parameters
key Type identifier constructed from plugin XML.

@Nonnull public List<CustomFieldSearcher> getCustomFieldSearchers (CustomFieldType customFieldType)

Retrieves all the searchers registered for a particular custom Field. Searchers may be registred via: 

   <customfield-searcher key="daterange" name="Date Range picker"
                     i18n-name-key="admin.customfield.searcher.daterange.name"
                     class="com.atlassian.jira.issue.customfields.searchers.DateRangeSearcher">

Parameters
customFieldType the CustomFieldType
Returns

public CustomFieldType getCustomFieldType (String key)

Retrieve a custom field type by its type key.

The key is the "full plugin module key". That is, the plugin key for the plugin it comes from, a colon separator, and then the module key. e.g. the system types are specified in system-customfieldtypes-plugin.xml: 

 <atlassian-plugin key="com.atlassian.jira.plugin.system.customfieldtypes" name="Custom Field Types & Searchers">
     ...
     <customfield-type key="float" name="Number Field"
     ...
To access the 'Number Field' type, the key would then be 'com.atlassian.jira.plugin.system.customfieldtypes:float'.

Parameters
key Type identifier constructed from plugin XML.
Returns
  • the CustomFieldType for the given key

@Nonnull public List<CustomFieldType<?, ?>> getCustomFieldTypes ()

Retrieve all customfieldtypes registered in the sytem.

Returns

@Nullable public CustomFieldSearcher getDefaultSearcher (CustomFieldType<?, ?> type)

Return the default CustomFieldSearcher for the passed CustomFieldType. The default searcher can be null if there is no searcher associated with the type.

Parameters
type the CustomFieldType to query.
Returns
  • the default searcher for the passed CustomFieldType. Can be null if the type has no associated searcher.

public List<CustomField> getGlobalCustomFieldObjects ()

Returns a list of custom fields where the isGlobal() is true.

Returns

public void refresh ()

reloads all customfields into the cache from the DB, this is an expensive operation, so avoid it if you can.

public void refreshConfigurationSchemes (Long customFieldId)

Causes a reload of the field configuration scheme for a specified custom field id Call when the configuration scheme changes

public void removeCustomField (CustomField customField)

Removes the customfield supplied including all associations and values.

Parameters
customField The CustomField to be removed.
Throws
RemoveException On any error removing the custom field

public void removeCustomFieldPossiblyLeavingOrphanedData (Long customFieldId)

Removes the customfield supplied. This method will try to lookup the customfield object via the manager first. If the customfield object can be retrieved this way, it simply delegates the removal to the removeCustomField(com.atlassian.jira.issue.fields.CustomField) method, which will not leave any orphaned data behind.

NOTE: Generally you should use the removeCustomField(com.atlassian.jira.issue.fields.CustomField) method to remove a custom field, as it is guaranteed to remove all data. This method should only be used if a customfield needs to be removed when the customfieldtype for that field is no longer available!

If however the customfield object cannot be retrieved via the manager, which may be the case if the custom field type is no longer available (a plugin may have been removed), then this method will try to lookup the custom field directly in the database. If it doesn't exist in the database, an IllegalArgumentException will be thrown. Otherwise, the customfield and all associated configurations will be removed. This method will also call to the removeAllValues(String) method to delete any values. Please note however, that if your custom field stores any other values (such as options for example), they will have to be removed by the caller of this method, as the custom field type is not accessible (which is usually responsible for removing such values).

Parameters
customFieldId The id of the customField to be removed.
Throws
RemoveException On any error removing the custom field
IllegalArgumentException If no customfield matching the customFieldId can be found

public void removeCustomFieldValues (GenericValue issue)

Removes the values stored by customfields for a particular Issue.

Parameters
issue The issue GenericValue
Throws
GenericEntityException DB error

public void removeProjectAssociations (Project project)

Used if a project is deleted to remove the project field associations.

Parameters
project The project being deleted.

public void removeProjectAssociations (GenericValue project)

This method is deprecated.
Use removeProjectAssociations(Project) instead. Since v5.1.

Used if a project is deleted to remove the project field associations.

Parameters
project The project being deleted.

public void removeProjectCategoryAssociations (ProjectCategory projectCategory)

Used if a project category is deleted to remove the field associations.

Parameters
projectCategory The project category being deleted.

public void updateCustomField (CustomField updatedField)

Updates the supplied custom field, refreshes the underlying cache

Parameters
updatedField updated Custom field