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

All Known Implementing Classes:
FieldConfigSchemeManagerImpl

public interface FieldConfigSchemeManager


Field Summary
static List<org.ofbiz.core.entity.GenericValue> ALL_ISSUE_TYPES
          This magic value list contains a single null element.
 
Method Summary
 FieldConfigScheme createDefaultScheme(ConfigurableField field, List<JiraContextNode> contexts)
           
 FieldConfigScheme createDefaultScheme(ConfigurableField field, List<JiraContextNode> contexts, List<org.ofbiz.core.entity.GenericValue> issueTypes)
           
 FieldConfigScheme createFieldConfigScheme(FieldConfigScheme newConfigScheme, List<JiraContextNode> contexts, List<org.ofbiz.core.entity.GenericValue> issueTypes, ConfigurableField field)
           
 List<Project> getAssociatedProjectObjects(ConfigurableField field)
          Returns a non-null list of Projects associated with the given field.
 List<org.ofbiz.core.entity.GenericValue> getAssociatedProjects(ConfigurableField field)
          Deprecated. Use getAssociatedProjectObjects(ConfigurableField) instead. Since v5.2.
 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)
           
 FieldConfigScheme getRelevantConfigScheme(IssueContext issueContext, ConfigurableField field)
           
 Object getValue(com.atlassian.bandana.BandanaContext context, String key)
           
 Object getValue(com.atlassian.bandana.BandanaContext context, String key, boolean lookUp)
           
 void init()
           
 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)
           
 void setValue(com.atlassian.bandana.BandanaContext context, String key, Object value)
           
 FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme scheme)
          Only update the name & description of a field
 FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme newScheme, List<JiraContextNode> contexts, ConfigurableField field)
          Updates the config schemes with the new contexts
 

Field Detail

ALL_ISSUE_TYPES

static final List<org.ofbiz.core.entity.GenericValue> ALL_ISSUE_TYPES
This magic value list contains a single null element. Do not change to an empty list.

Method Detail

init

void init()

getValue

Object getValue(com.atlassian.bandana.BandanaContext context,
                String key)

getValue

Object getValue(com.atlassian.bandana.BandanaContext context,
                String key,
                boolean lookUp)

setValue

void setValue(com.atlassian.bandana.BandanaContext context,
              String key,
              Object value)

getConfigSchemesForField

List<FieldConfigScheme> getConfigSchemesForField(ConfigurableField field)

getConfigSchemeForFieldConfig

FieldConfigScheme getConfigSchemeForFieldConfig(FieldConfig fieldConfig)
Retrieves the FieldConfigScheme associated with the FieldConfig

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

FieldConfigScheme getFieldConfigScheme(Long configSchemeId)

createDefaultScheme

FieldConfigScheme createDefaultScheme(ConfigurableField field,
                                      List<JiraContextNode> contexts,
                                      List<org.ofbiz.core.entity.GenericValue> issueTypes)

updateFieldConfigScheme

FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme newScheme,
                                          List<JiraContextNode> contexts,
                                          ConfigurableField field)
Updates the config schemes with the new contexts

Parameters:
newScheme -
contexts -
field -
Returns:
The updated scheme

updateFieldConfigScheme

FieldConfigScheme updateFieldConfigScheme(FieldConfigScheme scheme)
Only update the name & description of a field

Parameters:
scheme - scheme with the name & description to be updated
Returns:
the updated scheme

removeFieldConfigScheme

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)

Parameters:
fieldConfigSchemeId - the id of the field config scheme to remove

getRelevantConfig

FieldConfig getRelevantConfig(IssueContext issueContext,
                              ConfigurableField field)

createFieldConfigScheme

FieldConfigScheme createFieldConfigScheme(FieldConfigScheme newConfigScheme,
                                          List<JiraContextNode> contexts,
                                          List<org.ofbiz.core.entity.GenericValue> issueTypes,
                                          ConfigurableField field)

createDefaultScheme

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

removeSchemeAssociation

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

getAssociatedProjects

List<org.ofbiz.core.entity.GenericValue> getAssociatedProjects(ConfigurableField field)
Deprecated. Use getAssociatedProjectObjects(ConfigurableField) instead. Since v5.2.

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

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

getAssociatedProjectObjects

List<Project> getAssociatedProjectObjects(ConfigurableField field)
Returns a non-null list of Projects associated with the given field.

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

getRelevantConfigScheme

FieldConfigScheme getRelevantConfigScheme(IssueContext issueContext,
                                          ConfigurableField field)

getInvalidFieldConfigSchemesForIssueTypeRemoval

Collection getInvalidFieldConfigSchemesForIssueTypeRemoval(IssueType issueType)
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.

Parameters:
issueType - The issueType to be deleted
Returns:
A collection of FieldConfigSchemes
Since:
v3.11

removeInvalidFieldConfigSchemesForIssueType

void removeInvalidFieldConfigSchemesForIssueType(IssueType issueType)
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.

Parameters:
issueType - The IssueType being deleted
Since:
v3.11

removeInvalidFieldConfigSchemesForCustomField

void removeInvalidFieldConfigSchemesForCustomField(String customFieldId)
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.

Parameters:
customFieldId - The id of the CustomField being deleted
Since:
v3.13


Copyright © 2002-2014 Atlassian. All Rights Reserved.