@PublicApi
public interface CustomFieldManager
CustomField
s.Modifier and Type | Method and Description |
---|---|
void |
clear()
clear the cache
|
CustomField |
createCustomField(String fieldName,
String description,
CustomFieldType fieldType,
CustomFieldSearcher customFieldSearcher,
List<JiraContextNode> contexts,
List<IssueType> 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(org.ofbiz.core.entity.GenericValue customFieldGv)
Converts a customfield
GenericValue to a CustomField instance. |
CustomField |
getCustomFieldObject(Long id)
Get a CustomField by ID.
|
CustomField |
getCustomFieldObject(String id)
Get a CustomField by its text key (eg 'customfield_10000').
|
CustomField |
getCustomFieldObjectByName(String customFieldName)
Retrieve the first custom field object with the specified name.
|
List<CustomField> |
getCustomFieldObjects()
Returns all custom fields.
|
List<CustomField> |
getCustomFieldObjects(org.ofbiz.core.entity.GenericValue issue)
Returns a list of
CustomField s that apply to a particular issue. |
List<CustomField> |
getCustomFieldObjects(Issue issue)
Returns a list of
CustomField s 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(SearchContext searchContext)
Returns all customfields in a particular
SearchContext . |
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.
|
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.
|
List<CustomFieldType<?,?>> |
getCustomFieldTypes()
Retrieve all customfieldtypes registered in the system.
|
CustomFieldSearcher |
getDefaultSearcher(CustomFieldType<?,?> type)
Return the default
CustomFieldSearcher for the passed CustomFieldType . |
List<CustomField> |
getGlobalCustomFieldObjects()
Returns a list of custom fields where the
CustomField.isGlobal()
is true. |
boolean |
isCustomField(String id)
Returns true if this ID is in the Custom Field format.
|
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(org.ofbiz.core.entity.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 |
updateCustomField(Long id,
String name,
String description,
CustomFieldSearcher searcher)
Updates the given custom field.
|
Collection<CustomField> getCustomFieldObjectsByName(String customFieldName)
customFieldName
- custom field nameCustomField
s.CustomField getCustomFieldObjectByName(String customFieldName)
getCustomFieldObjectsByName(String)
to retrieve all custom fields.customFieldName
- the NameCustomField
, or null if not found.@Nullable CustomField getCustomFieldObject(Long id)
id
- ID of field, eg. 10000CustomField
or null.@Nullable CustomField getCustomFieldObject(String id)
id
- Eg. 'customfield_10000'CustomField
or null if not found.boolean isCustomField(String id)
Note that this does not check if the Custom Field actually exists. It just checks whether the given ID looks like Custom Field ID (eg starts with "customfield_").
id
- The Field IDexists(String)
boolean exists(String id)
id
- Eg. 'customfield_10000'isCustomField(String)
List<CustomField> getCustomFieldObjects()
CustomField
s.List<CustomField> getGlobalCustomFieldObjects()
CustomField.isGlobal()
is true.CustomField
sList<CustomField> getCustomFieldObjects(Long projectId, String issueType)
projectId
- Id of the projectissueType
- An issue type. See ConstantsManager.ALL_ISSUE_TYPES
,
ConstantsManager.ALL_STANDARD_ISSUE_TYPES
and ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES
CustomField
sList<CustomField> getCustomFieldObjects(Long projectId, List<String> issueTypes)
getCustomFieldObjects(Long, String)
but allows to specify a list of issueTypes.projectId
- Id of the project. It can be null, in which case means that we are looking for "any project" (acts like a wildcard).issueTypes
- A list of issue types. It can be null or empty, in which case means that we are looking for "any issue type" (acts like a wildcard).
See ConstantsManager.ALL_ISSUE_TYPES
, ConstantsManager.ALL_STANDARD_ISSUE_TYPES
and ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES
CustomField
sCustomField#isInScopeForSearch(com.atlassian.jira.project.Project, java.util.List)} for a full description on how wildcards are treated.
List<CustomField> getCustomFieldObjects(SearchContext searchContext)
SearchContext
. Also
see CustomField.isInScope(com.atlassian.jira.issue.search.SearchContext)
.searchContext
- the SearchContextCustomField
sList<CustomField> getCustomFieldObjects(org.ofbiz.core.entity.GenericValue issue)
CustomField
s that apply to a particular issue.issue
- A GenericValue
of the issueCustomField
sList<CustomField> getCustomFieldObjects(Issue issue)
CustomField
s that apply to a particular issue.issue
- A Issue
objectCustomField
s@Nonnull List<CustomFieldType<?,?>> getCustomFieldTypes()
CustomFieldType
sCustomFieldType getCustomFieldType(String 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'.
key
- Type identifier constructed from plugin XML.@Nonnull List<CustomFieldSearcher> getCustomFieldSearchers(CustomFieldType customFieldType)
<customfield-searcher key="daterange" name="Date Range picker" i18n-name-key="admin.customfield.searcher.daterange.name" class="com.atlassian.jira.issue.customfields.searchers.DateRangeSearcher">
customFieldType
- the CustomFieldTypeCustomFieldSearcher
sCustomFieldSearcher getCustomFieldSearcher(String 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'.
key
- Type identifier constructed from plugin XML.@Nullable CustomFieldSearcher getDefaultSearcher(@Nonnull CustomFieldType<?,?> type)
CustomFieldSearcher
for the passed CustomFieldType
. The default searcher can
be null if there is no searcher associated with the type.type
- the CustomFieldType
to query.CustomFieldType
. Can be null if the type has no associated
searcher.CustomField createCustomField(String fieldName, String description, CustomFieldType fieldType, CustomFieldSearcher customFieldSearcher, List<JiraContextNode> contexts, List<IssueType> issueTypes) throws org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericEntityException
- if the CustomField could not be created.void removeCustomFieldPossiblyLeavingOrphanedData(Long customFieldId) throws RemoveException, IllegalArgumentException
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 CustomFieldValuePersister.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).
customFieldId
- The id of the customField to be removed.RemoveException
- On any error removing the custom fieldIllegalArgumentException
- If no customfield matching the customFieldId can be foundvoid removeCustomField(CustomField customField) throws RemoveException
customField
- The CustomField
to be removed.RemoveException
- On any error removing the custom fieldvoid updateCustomField(Long id, String name, String description, CustomFieldSearcher searcher)
id
- the custom field IDname
- the new namedescription
- the new descriptionsearcher
- the new Searchervoid removeCustomFieldValues(org.ofbiz.core.entity.GenericValue issue) throws org.ofbiz.core.entity.GenericEntityException
issue
- The issue GenericValue
org.ofbiz.core.entity.GenericEntityException
- DB errorvoid removeProjectAssociations(Project project)
project
- The project being deleted.CustomField getCustomFieldInstance(org.ofbiz.core.entity.GenericValue customFieldGv)
GenericValue
to a CustomField
instance.customFieldGv
- CustomField
instancevoid refresh()
void refreshConfigurationSchemes(Long customFieldId)
customFieldId
- the custom field IDvoid clear()
Class<? extends CustomFieldSearcher> getCustomFieldSearcherClass(String 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'.
key
- Type identifier constructed from plugin XML.Copyright © 2002-2015 Atlassian. All Rights Reserved.