com.atlassian.jira.issue.fields.config.manager

Class FieldConfigSchemeManagerImpl

java.lang.Object

com.atlassian.jira.issue.fields.config.manager.FieldConfigSchemeManagerImpl

All Implemented Interfaces:

FieldConfigSchemeManager

public class FieldConfigSchemeManagerImpl
extends Object
implements FieldConfigSchemeManager

Field Summary

Fields inherited from interface com.atlassian.jira.issue.fields.config.manager.FieldConfigSchemeManager

ALL_ISSUE_TYPES

Constructor Summary

Constructors

Constructor and Description
FieldConfigSchemeManagerImpl(FieldConfigSchemePersister configSchemePersister, FieldConfigContextPersister contextPersister, FieldConfigManager configManager, CustomFieldContextHandler customFieldContextHandler, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
FieldConfigScheme	addAssociatedContexts(FieldConfigScheme scheme, Set<JiraContextNode> contextsToBeAdded, ConfigurableField field) Adds new contexts to a config scheme
FieldConfigScheme	createDefaultScheme(ConfigurableField field, List<JiraContextNode> contexts)
FieldConfigScheme	createDefaultScheme(ConfigurableField field, List<JiraContextNode> contexts, List<IssueType> issueTypes)
FieldConfigScheme	createFieldConfigScheme(FieldConfigScheme newConfigScheme, List<JiraContextNode> contexts, List<IssueType> issueTypes, ConfigurableField field)
List<Project>	getAssociatedProjectObjects(ConfigurableField field) Returns a non-null list of Projects associated with the given field.
FieldConfigScheme	getConfigSchemeForFieldConfig(FieldConfig fieldConfig) Retrieves the FieldConfigScheme associated with the FieldConfig
List<FieldConfigScheme>	getConfigSchemesForField(ConfigurableField field)
FieldConfigScheme	getFieldConfigScheme(Long configSchemeId)
Collection	getInvalidFieldConfigSchemesForIssueTypeRemoval(IssueType issueType) Returns a collection of FieldConfigSchemes for all Configuration Contexts that will become invalid after the issuetype has been removed.
FieldConfig	getRelevantConfig(IssueContext issueContext, ConfigurableField field) Returns the relevant field config of this custom field for the give issue context
FieldConfigScheme	getRelevantConfigScheme(IssueContext issueContext, ConfigurableField field) Returns the FieldConfigScheme for the given Project and ConfigurableField.
FieldConfigScheme	getRelevantConfigScheme(Project project, ConfigurableField field) Returns the FieldConfigScheme for the given Project and ConfigurableField.
void	init()
boolean	isRelevantForIssueContext(IssueContext issueContext, ConfigurableField field) Returns true if the custom field has a config for the Project and Issue Type of the given IssueContext.
FieldConfigScheme	removeAssociatedContexts(FieldConfigScheme scheme, Set<JiraContextNode> contextsToBeRemoved, ConfigurableField field) Removes contexts from a config scheme
void	removeFieldConfigScheme(Long fieldConfigSchemeId) Removes a field config scheme, as well as its associated contexts and field configs (which includes option sets and generic configs)
void	removeInvalidFieldConfigSchemesForCustomField(String customFieldId) Given a CustomField, this method will correctly remove the fieldConfigSchemes if necessary.
void	removeInvalidFieldConfigSchemesForIssueType(IssueType issueType) Given an issueType, this method will correctly remove the fieldConfigSchemes if necessary.
void	removeSchemeAssociation(List<JiraContextNode> contexts, ConfigurableField configurableField)
FieldConfigScheme	updateFieldConfigScheme(FieldConfigScheme scheme) Only update the name & description of a field
FieldConfigScheme	updateFieldConfigScheme(FieldConfigScheme scheme, List<JiraContextNode> contexts, ConfigurableField field) Updates the config schemes with the new contexts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldConfigSchemeManagerImpl

public FieldConfigSchemeManagerImpl(FieldConfigSchemePersister configSchemePersister,
                                    FieldConfigContextPersister contextPersister,
                                    FieldConfigManager configManager,
                                    CustomFieldContextHandler customFieldContextHandler,
                                    com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

init

public void init()

Specified by:

init in interface FieldConfigSchemeManager

getConfigSchemesForField

public List<FieldConfigScheme> getConfigSchemesForField(ConfigurableField field)

Specified by:

getConfigSchemesForField in interface FieldConfigSchemeManager

getConfigSchemeForFieldConfig

public FieldConfigScheme getConfigSchemeForFieldConfig(FieldConfig fieldConfig)

Description copied from interface: FieldConfigSchemeManager

Retrieves the FieldConfigScheme associated with the FieldConfig

Specified by:

getConfigSchemeForFieldConfig in interface FieldConfigSchemeManager

Parameters:

fieldConfig - the field config to retrieve the FieldConfigScheme of; cannot be null.

Returns:

the config scheme for the FieldConfig. Null if the config scheme can not be found.

getFieldConfigScheme

public FieldConfigScheme getFieldConfigScheme(Long configSchemeId)

Specified by:

getFieldConfigScheme in interface FieldConfigSchemeManager

createFieldConfigScheme

public FieldConfigScheme createFieldConfigScheme(FieldConfigScheme newConfigScheme,
                                                 List<JiraContextNode> contexts,
                                                 List<IssueType> issueTypes,
                                                 ConfigurableField field)

Specified by:

createFieldConfigScheme in interface FieldConfigSchemeManager

createDefaultScheme

public FieldConfigScheme createDefaultScheme(ConfigurableField field,
                                             List<JiraContextNode> contexts,
                                             List<IssueType> issueTypes)

Specified by:

createDefaultScheme in interface FieldConfigSchemeManager

createDefaultScheme

public FieldConfigScheme createDefaultScheme(ConfigurableField field,
                                             List<JiraContextNode> contexts)

Specified by:

createDefaultScheme in interface FieldConfigSchemeManager

removeSchemeAssociation

public void removeSchemeAssociation(List<JiraContextNode> contexts,
                                    ConfigurableField configurableField)

Specified by:

removeSchemeAssociation in interface FieldConfigSchemeManager

getAssociatedProjectObjects

public List<Project> getAssociatedProjectObjects(ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Returns a non-null list of Projects associated with the given field.

Specified by:

getAssociatedProjectObjects in interface FieldConfigSchemeManager

Parameters:

field - the Field

Returns:

a non-null list of Projects associated with the given field.

updateFieldConfigScheme

public FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme scheme,
                                                 List<JiraContextNode> contexts,
                                                 ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Updates the config schemes with the new contexts

Specified by:

updateFieldConfigScheme in interface FieldConfigSchemeManager

Returns:

The updated scheme

addAssociatedContexts

public FieldConfigScheme addAssociatedContexts(FieldConfigScheme scheme,
                                               Set<JiraContextNode> contextsToBeAdded,
                                               ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Adds new contexts to a config scheme

Specified by:

addAssociatedContexts in interface FieldConfigSchemeManager

Returns:

The updated scheme

removeAssociatedContexts

public FieldConfigScheme removeAssociatedContexts(FieldConfigScheme scheme,
                                                  Set<JiraContextNode> contextsToBeRemoved,
                                                  ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Removes contexts from a config scheme

Specified by:

removeAssociatedContexts in interface FieldConfigSchemeManager

Returns:

The updated scheme

updateFieldConfigScheme

public FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme scheme)

Description copied from interface: FieldConfigSchemeManager

Only update the name & description of a field

Specified by:

updateFieldConfigScheme in interface FieldConfigSchemeManager

Parameters:

scheme - scheme with the name & description to be updated

Returns:

the updated scheme

removeFieldConfigScheme

public void removeFieldConfigScheme(Long fieldConfigSchemeId)

Description copied from interface: FieldConfigSchemeManager

Removes a field config scheme, as well as its associated contexts and field configs (which includes option sets and generic configs)

Specified by:

removeFieldConfigScheme in interface FieldConfigSchemeManager

Parameters:

fieldConfigSchemeId - the id of the field config scheme to remove

removeInvalidFieldConfigSchemesForIssueType

public void removeInvalidFieldConfigSchemesForIssueType(IssueType issueType)

Description copied from interface: FieldConfigSchemeManager

Given an issueType, this method will correctly remove the fieldConfigSchemes if necessary. In other words if a FieldConfigScheme is linked to only a single issueType, and we're deleting that issuetype then that FieldConfigScheme will be deleted. If a FieldConfigScheme is associated with multiple issueTypes, then only the association for the issueType we're deleting will be removed, but the FieldConfigScheme will remain.

Specified by:

removeInvalidFieldConfigSchemesForIssueType in interface FieldConfigSchemeManager

Parameters:

issueType - The IssueType being deleted

removeInvalidFieldConfigSchemesForCustomField

public void removeInvalidFieldConfigSchemesForCustomField(String customFieldId)

Description copied from interface: FieldConfigSchemeManager

Given a CustomField, this method will correctly remove the fieldConfigSchemes if necessary. In other words if a FieldConfigScheme is linked to only a single CustomField, and we're deleting that field then that FieldConfigScheme will be deleted. If a FieldConfigScheme is associated with multiple fields, then only the association for the field we're deleting will be removed, but the FieldConfigScheme will remain.

Specified by:

removeInvalidFieldConfigSchemesForCustomField in interface FieldConfigSchemeManager

Parameters:

customFieldId - The id of the CustomField being deleted

getInvalidFieldConfigSchemesForIssueTypeRemoval

public Collection getInvalidFieldConfigSchemesForIssueTypeRemoval(IssueType issueType)

Description copied from interface: FieldConfigSchemeManager

Returns a collection of FieldConfigSchemes for all Configuration Contexts that will become invalid after the issuetype has been removed. That is the configuration contexts that will no longer be linked to ANY issue types after the issue type passed is has been deleted.

Specified by:

getInvalidFieldConfigSchemesForIssueTypeRemoval in interface FieldConfigSchemeManager

Parameters:

issueType - The issueType to be deleted

Returns:

A collection of FieldConfigSchemes

isRelevantForIssueContext

public boolean isRelevantForIssueContext(IssueContext issueContext,
                                         ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Returns true if the custom field has a config for the Project and Issue Type of the given IssueContext.

This is equivalent to calling

  getRelevantConfig(issueContext, field) != null

but in general can run faster because it does not have to resolve the actual FieldConfig.

Specified by:

isRelevantForIssueContext in interface FieldConfigSchemeManager

Parameters:

issueContext - IssueContext whose project and issue type will be used to check if the field has a config

Returns:

true if the custom field has a config for the Project and Issue Type of the given IssueContext.

See Also:

FieldConfigSchemeManager.getRelevantConfig(com.atlassian.jira.issue.context.IssueContext, com.atlassian.jira.issue.fields.ConfigurableField)

getRelevantConfig

public FieldConfig getRelevantConfig(IssueContext issueContext,
                                     ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Returns the relevant field config of this custom field for the give issue context

Specified by:

getRelevantConfig in interface FieldConfigSchemeManager

Parameters:

issueContext - issue context to find the relevant field config for

Returns:

the relevant field config of this custom field for the give issue context

See Also:

FieldConfigSchemeManager.isRelevantForIssueContext(com.atlassian.jira.issue.context.IssueContext, com.atlassian.jira.issue.fields.ConfigurableField)

getRelevantConfigScheme

@Nullable
public FieldConfigScheme getRelevantConfigScheme(IssueContext issueContext,
                                                           ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Returns the FieldConfigScheme for the given Project and ConfigurableField.

Specified by:

getRelevantConfigScheme in interface FieldConfigSchemeManager

Parameters:

issueContext - actually we ignore the Issue Type and just use the Project.

field - the ConfigurableField

Returns:

the FieldConfigScheme for the given Project and ConfigurableField.

getRelevantConfigScheme

@Nullable
public FieldConfigScheme getRelevantConfigScheme(Project project,
                                                           ConfigurableField field)

Description copied from interface: FieldConfigSchemeManager

Returns the FieldConfigScheme for the given Project and ConfigurableField.

Specified by:

getRelevantConfigScheme in interface FieldConfigSchemeManager

Parameters:

project - the Project.

field - the ConfigurableField

Returns:

the FieldConfigScheme for the given Project and ConfigurableField.