Package com.atlassian.jira.issue.fields.layout.field

Class DefaultFieldLayoutManager

java.lang.Object

com.atlassian.jira.issue.fields.layout.field.AbstractFieldLayoutManager

com.atlassian.jira.issue.fields.layout.field.DefaultFieldLayoutManager

All Implemented Interfaces:

InitializingComponent, FieldLayoutManager

public class DefaultFieldLayoutManager
extends AbstractFieldLayoutManager
implements FieldLayoutManager

Field Summary

Fields inherited from class com.atlassian.jira.issue.fields.layout.field.AbstractFieldLayoutManager

cacheManager, DESCRIPTION, FIELD_LAYOUT, fieldManager, i18nFactory, NAME, ofBizDelegator, SCHEME, SCHEME_ASSOCIATION, TYPE

Fields inherited from interface com.atlassian.jira.issue.fields.layout.field.FieldLayoutManager

TYPE_DEFAULT

Constructor Summary

Constructors

Constructor

Description

DefaultFieldLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, ConstantsManager constantsManager, SubTaskManager subTaskManager, ProjectManager projectManager, I18nHelper.BeanFactory i18nFactory, NodeAssociationStore nodeAssociationStore, com.atlassian.cache.CacheManager cacheManager, com.atlassian.event.api.EventPublisher eventPublisher, ApplicationProperties applicationProperties, QueryDslAccessor queryDslAccessor)

Method Summary

Modifier and Type	Method	Description
void	addSchemeAssociation(Project project, Long fieldLayoutSchemeId)	Associates a FieldLayoutScheme to the project supplied.
void	addSchemeAssociation(org.ofbiz.core.entity.GenericValue project, Long fieldLayoutSchemeId)	Associates a FieldLayoutScheme to the project supplied.
void	afterInstantiation()	Called after all the beans are constructed and the ApplicationContext is fully populated.
protected void	clearCaches()
FieldLayoutScheme	copyFieldLayoutScheme(FieldLayoutScheme scheme, String name, String description)	Copies an existing field layout to a new one.
FieldLayoutScheme	createFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)	Persists a new field Layout scheme (i.e Field Configuration Scheme).
FieldLayoutScheme	createFieldLayoutScheme(String name, String description)	Persists a new field Layout scheme (i.e Field Configuration Scheme).
void	createFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)	Persists a new FieldLayoutSchemeEntity for a particular FieldLayoutScheme.
FieldLayoutSchemeEntity	createFieldLayoutSchemeEntity(FieldLayoutScheme fieldLayoutScheme, String issueTypeId, Long fieldLayoutId)	Persists a new FieldLayoutSchemeEntity for a particular FieldLayoutScheme.
protected FieldLayoutSchemeEntity	createFieldLayoutSchemeEntityNoEvent(FieldLayoutScheme fieldLayoutScheme, String issueTypeId, Long fieldLayoutId)
void	deleteFieldLayout(FieldLayout fieldLayout)	Deletes a custom FieldLayout
void	deleteFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)	Removes the FieldLayoutScheme supplied.
boolean	fieldConfigurationSchemeExists(String schemeName)	Checks if a FieldConfigurationScheme with the given name exists.
protected List<String>	getAllRelevantIssueTypeIds()
EditableFieldLayout	getEditableFieldLayout(Long id)	Returns an EditableFieldLayout for the id supplied.
List<EditableFieldLayout>	getEditableFieldLayouts()	Retrieves editable (see EditableFieldLayout versions of the field layouts.
FieldConfigurationScheme	getFieldConfigurationScheme(Project project)	Retrieves the Field Configuration Scheme associated with the supplied project.
FieldConfigurationScheme	getFieldConfigurationScheme(Long schemeId)	Retrieves a FieldConfigurationScheme by id
FieldConfigurationScheme	getFieldConfigurationSchemeForProject(Long projectId)	Retrieves the Field Configuration Scheme associated with the supplied project.
Collection<FieldConfigurationScheme>	getFieldConfigurationSchemes(FieldLayout fieldLayout)	Returns a collection of FieldConfigurationSchemes that include the given FieldLayout.
FieldLayout	getFieldLayout(Project project, String issueTypeId)
FieldLayout	getFieldLayout(Long id)	Used to retrieve FieldLayout information when rendering a screen given the id of the field layout.
FieldLayout	getFieldLayout(Long projectId, String issueTypeId)	Find the FieldLayout for the given Project and IssueType.
FieldLayout	getFieldLayout(org.ofbiz.core.entity.GenericValue issue)	Returns the fieldLayout for an issue.
Collection<FieldLayoutSchemeEntity>	getFieldLayoutSchemeEntities(FieldLayoutScheme fieldLayoutScheme)	Returns a collection of FieldLayoutSchemeEntitys.
List<FieldLayoutScheme>	getFieldLayoutSchemes()	Retries Field Configuration Schemes.
FieldLayoutScheme	getMutableFieldLayoutScheme(Long schemeId)	Retrieves a mutable FieldLayoutScheme by id.
Collection<org.ofbiz.core.entity.GenericValue>	getProjects(FieldConfigurationScheme fieldConfigurationScheme)	Returns all projects that use the given FieldConfigurationScheme.
Collection<org.ofbiz.core.entity.GenericValue>	getProjects(FieldLayoutScheme fieldLayoutScheme)	Returns all associated projects for the FieldLayoutScheme supplied.
Collection<Project>	getProjectsUsing(FieldConfigurationScheme fieldConfigurationScheme)	Returns all projects that use the given FieldConfigurationScheme.
Collection<Project>	getProjectsUsing(FieldLayout fieldLayout)	Finds all projects that use the given FieldLayout (via the configured FieldConfigurationScheme).
Collection<Project>	getProjectsUsing(FieldLayoutScheme fieldLayoutScheme)	Returns all projects that use the given FieldLayoutScheme.
Collection<org.ofbiz.core.entity.GenericValue>	getRelatedProjects(FieldLayout fieldLayout)	Finds all projects that use the given FieldLayout (via the configured FieldConfigurationScheme).
Set<FieldLayout>	getUniqueFieldLayouts(Project project)	Retrieves all the FieldLayout's for a project.
Set<FieldLayout>	getUniqueFieldLayouts(Collection<Project> projects, Collection<String> issueTypeIds)	Retrieves all the FieldLayout's for a collection of projects and issue types.
boolean	isFieldLayoutSchemesVisiblyEquivalent(Long fieldConfigurationSchemeId1, Long fieldConfigurationSchemeId2)	Will determine whether or not two FieldLayoutSchemes are "visibly equivalent".
boolean	isFieldLayoutsVisiblyEquivalent(Long fieldLayoutId1, Long fieldLayoutId2)	Will determine whether or not two FieldLayouts are "visibly equivalent".
void	onClearCache(ClearCacheEvent event)
void	refresh()	Clears all local caches.
void	removeFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)
void	removeFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)	Removes a FieldLayoutSchemeEntity
protected void	removeFieldLayoutSchemeEntityNoEvent(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)
void	removeSchemeAssociation(Project project, Long fieldLayoutSchemeId)	Removes an association between a particular project and field configuration scheme.
void	removeSchemeAssociation(org.ofbiz.core.entity.GenericValue project, Long fieldLayoutSchemeId)	Removes an association between a particular project and field configuration scheme.
void	updateFieldLayoutItemAttributesForCustomField(CustomField customField, String description, boolean isRequired, boolean isHidden)	Update the description, isHidden and isRequired columns of all the fieldlayoutitem rows associated with this custom field.
void	updateFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)	Persists the FieldLayoutScheme supplied.
void	updateFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)	Updates a FieldLayoutSchemeEntity.

Methods inherited from class com.atlassian.jira.issue.fields.layout.field.AbstractFieldLayoutManager

getDefaultDescription, getDefaultFieldLayoutItems, getEditableDefaultFieldLayout, getFieldLayout, getFieldLayout, getI18nHelper, getRelevantFieldLayout, hasDefaultFieldLayout, onCustomFieldUpdated, refreshCaches, refreshCacheWhenUpdateAllowUnassignedOption, restoreDefaultFieldLayout, restoreFieldLayout, storeAndReturnEditableFieldLayout, storeEditableDefaultFieldLayout, storeEditableFieldLayout

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.layout.field.FieldLayoutManager

getEditableDefaultFieldLayout, getFieldLayout, getFieldLayout, hasDefaultFieldLayout, restoreDefaultFieldLayout, storeAndReturnEditableFieldLayout, storeEditableDefaultFieldLayout, storeEditableFieldLayout

Constructor Details

DefaultFieldLayoutManager

public DefaultFieldLayoutManager(FieldManager fieldManager,
 OfBizDelegator ofBizDelegator,
 ConstantsManager constantsManager,
 SubTaskManager subTaskManager,
 ProjectManager projectManager,
 I18nHelper.BeanFactory i18nFactory,
 NodeAssociationStore nodeAssociationStore,
 com.atlassian.cache.CacheManager cacheManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ApplicationProperties applicationProperties,
 QueryDslAccessor queryDslAccessor)

Method Details

afterInstantiation

public void afterInstantiation()
                        throws Exception

Description copied from interface: InitializingComponent

Called after all the beans are constructed and the ApplicationContext is fully populated. Order of execution is order of bean creation, driven by InitializingComponentProcessor.

Specified by:

afterInstantiation in interface InitializingComponent

Overrides:

afterInstantiation in class AbstractFieldLayoutManager

Throws:

Exception

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getFieldLayout

public FieldLayout getFieldLayout(org.ofbiz.core.entity.GenericValue issue)

Description copied from interface: FieldLayoutManager

Returns the fieldLayout for an issue.

Specified by:

getFieldLayout in interface FieldLayoutManager

Parameters:

issue - An issue GenericValue

Returns:

A FieldLayout

getFieldLayout

public FieldLayout getFieldLayout(Project project,
 String issueTypeId)

Specified by:

getFieldLayout in interface FieldLayoutManager

Parameters:

project - A project

issueTypeId - The IssueType id of the issue.

Returns:

A FieldLayout

See Also:

• FieldLayoutManager.getFieldLayout(Issue)

getFieldLayout

public FieldLayout getFieldLayout(@Nonnull
 Long projectId,
 @Nonnull
 String issueTypeId)

Description copied from interface: FieldLayoutManager

Find the FieldLayout for the given Project and IssueType.

Specified by:

getFieldLayout in interface FieldLayoutManager

Parameters:

projectId - the project

issueTypeId - the issue type

Returns:

the FieldLayout for the given Project and IssueType.

getFieldLayoutSchemes

public List<FieldLayoutScheme> getFieldLayoutSchemes()

Description copied from interface: FieldLayoutManager

Retries Field Configuration Schemes. These are used to link field configurations to projects.

Specified by:

getFieldLayoutSchemes in interface FieldLayoutManager

Returns:

A list of FieldLayoutSchemes.

getRelatedProjects

public Collection<org.ofbiz.core.entity.GenericValue> getRelatedProjects(FieldLayout fieldLayout)

Description copied from interface: FieldLayoutManager

Finds all projects that use the given FieldLayout (via the configured FieldConfigurationScheme).

NOTE: In the case of Standard & Professional, this simply returns ALL projects, as the only fieldlayout is the default field layout.

Specified by:

getRelatedProjects in interface FieldLayoutManager

Parameters:

fieldLayout - The FieldLayout.

Returns:

The set of Projects that use the given FieldLayout.

getProjectsUsing

public Collection<Project> getProjectsUsing(FieldLayout fieldLayout)

Description copied from interface: FieldLayoutManager

Finds all projects that use the given FieldLayout (via the configured FieldConfigurationScheme).

NOTE: In the case of Standard & Professional, this simply returns ALL projects, as the only fieldlayout is the default field layout.

Specified by:

getProjectsUsing in interface FieldLayoutManager

Parameters:

fieldLayout - The FieldLayout.

Returns:

The set of Projects that use the given FieldLayout.

getEditableFieldLayouts

public List<EditableFieldLayout> getEditableFieldLayouts()

Description copied from interface: FieldLayoutManager

Retrieves editable (see EditableFieldLayout versions of the field layouts. Note: For standard edition this simply returns an editable version of the default field layout. (see EditableDefaultFieldLayout)

Specified by:

getEditableFieldLayouts in interface FieldLayoutManager

Returns:

A list of EditableFieldLayout and EditableDefaultFieldLayout

getEditableFieldLayout

public EditableFieldLayout getEditableFieldLayout(Long id)

Description copied from interface: FieldLayoutManager

Returns an EditableFieldLayout for the id supplied.

Specified by:

getEditableFieldLayout in interface FieldLayoutManager

Parameters:

id - If the id is NULL, the default layout is returned.

Returns:

An EditableFieldLayout

updateFieldLayoutScheme

public void updateFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Persists the FieldLayoutScheme supplied.

Specified by:

updateFieldLayoutScheme in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - The FieldLayoutScheme

deleteFieldLayoutScheme

public void deleteFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Removes the FieldLayoutScheme supplied.

Specified by:

deleteFieldLayoutScheme in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - The FieldLayoutScheme

deleteFieldLayout

public void deleteFieldLayout(FieldLayout fieldLayout)

Description copied from interface: FieldLayoutManager

Deletes a custom FieldLayout

Specified by:

deleteFieldLayout in interface FieldLayoutManager

Parameters:

fieldLayout - The FieldLayout

getFieldLayoutSchemeEntities

public Collection<FieldLayoutSchemeEntity> getFieldLayoutSchemeEntities(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Returns a collection of FieldLayoutSchemeEntitys. These are used to record mappings from IssueType -> FieldLayout for the FieldLayoutScheme passed in.

Specified by:

getFieldLayoutSchemeEntities in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - The FieldLayoutScheme

Returns:

A collection of FieldLayoutSchemeEntitys.

createFieldLayoutSchemeEntity

public void createFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

Description copied from interface: FieldLayoutManager

Persists a new FieldLayoutSchemeEntity for a particular FieldLayoutScheme. The appropriate scheme is retrieved using FieldLayoutSchemeEntity.getFieldLayoutScheme()

Specified by:

createFieldLayoutSchemeEntity in interface FieldLayoutManager

Parameters:

fieldLayoutSchemeEntity - The FieldLayoutSchemeEntity

updateFieldLayoutSchemeEntity

public void updateFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

Description copied from interface: FieldLayoutManager

Updates a FieldLayoutSchemeEntity.

Specified by:

updateFieldLayoutSchemeEntity in interface FieldLayoutManager

Parameters:

fieldLayoutSchemeEntity - The FieldLayoutSchemeEntity

removeFieldLayoutSchemeEntityNoEvent

protected void removeFieldLayoutSchemeEntityNoEvent(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

removeFieldLayoutSchemeEntity

public void removeFieldLayoutSchemeEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

Description copied from interface: FieldLayoutManager

Removes a FieldLayoutSchemeEntity

Specified by:

removeFieldLayoutSchemeEntity in interface FieldLayoutManager

Parameters:

fieldLayoutSchemeEntity - The FieldLayoutSchemeEntity

removeFieldLayoutScheme

public void removeFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)

Specified by:

removeFieldLayoutScheme in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - The FieldLayoutScheme

getFieldConfigurationSchemes

public Collection<FieldConfigurationScheme> getFieldConfigurationSchemes(FieldLayout fieldLayout)

Description copied from interface: FieldLayoutManager

Returns a collection of FieldConfigurationSchemes that include the given FieldLayout.

This is determined by retrieving all FieldLayoutSchemeEntitys with the FieldLayout and calculating a set of FieldConfigurationSchemes using these entities.

Specified by:

getFieldConfigurationSchemes in interface FieldLayoutManager

Parameters:

fieldLayout - The FieldLayout.

Returns:

A collection of FieldConfigurationSchemes

getProjects

public Collection<org.ofbiz.core.entity.GenericValue> getProjects(FieldConfigurationScheme fieldConfigurationScheme)

Description copied from interface: FieldLayoutManager

Returns all projects that use the given FieldConfigurationScheme.

Specified by:

getProjects in interface FieldLayoutManager

Parameters:

fieldConfigurationScheme - the FieldConfigurationScheme

Returns:

A list of projects that use the given FieldConfigurationScheme.

getProjectsUsing

public Collection<Project> getProjectsUsing(FieldConfigurationScheme fieldConfigurationScheme)

Description copied from interface: FieldLayoutManager

Returns all projects that use the given FieldConfigurationScheme.

Specified by:

getProjectsUsing in interface FieldLayoutManager

Parameters:

fieldConfigurationScheme - the FieldConfigurationScheme

Returns:

A list of projects that use the given FieldConfigurationScheme.

getProjects

public Collection<org.ofbiz.core.entity.GenericValue> getProjects(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Returns all associated projects for the FieldLayoutScheme supplied.

Specified by:

getProjects in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - the FieldLayoutScheme

Returns:

A list of project GenericValues

getProjectsUsing

public Collection<Project> getProjectsUsing(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Returns all projects that use the given FieldLayoutScheme.

Specified by:

getProjectsUsing in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - the FieldLayoutScheme

Returns:

A list of projects that use the given FieldLayoutScheme.

createFieldLayoutScheme

public FieldLayoutScheme createFieldLayoutScheme(FieldLayoutScheme fieldLayoutScheme)

Description copied from interface: FieldLayoutManager

Persists a new field Layout scheme (i.e Field Configuration Scheme).

Specified by:

createFieldLayoutScheme in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - The FieldLayoutScheme to persist.

Returns:

The stored FieldLayoutScheme object

createFieldLayoutScheme

public FieldLayoutScheme createFieldLayoutScheme(@Nonnull
 String name,
 @Nullable
 String description)

Description copied from interface: FieldLayoutManager

Persists a new field Layout scheme (i.e Field Configuration Scheme).

Specified by:

createFieldLayoutScheme in interface FieldLayoutManager

createFieldLayoutSchemeEntity

public FieldLayoutSchemeEntity createFieldLayoutSchemeEntity(@Nonnull
 FieldLayoutScheme fieldLayoutScheme,
 @Nullable
 String issueTypeId,
 @Nullable
 Long fieldLayoutId)

Description copied from interface: FieldLayoutManager

Persists a new FieldLayoutSchemeEntity for a particular FieldLayoutScheme. The appropriate scheme is retrieved using FieldLayoutSchemeEntity.getFieldLayoutScheme()

Specified by:

createFieldLayoutSchemeEntity in interface FieldLayoutManager

Parameters:

fieldLayoutScheme - the FieldLayoutScheme

issueTypeId - the Issue Type

fieldLayoutId - the FieldConfig

createFieldLayoutSchemeEntityNoEvent

protected FieldLayoutSchemeEntity createFieldLayoutSchemeEntityNoEvent(@Nonnull
 FieldLayoutScheme fieldLayoutScheme,
 @Nullable
 String issueTypeId,
 @Nullable
 Long fieldLayoutId)

copyFieldLayoutScheme

public FieldLayoutScheme copyFieldLayoutScheme(@Nonnull
 FieldLayoutScheme scheme,
 @Nonnull
 String name,
 @Nullable
 String description)

Description copied from interface: FieldLayoutManager

Copies an existing field layout to a new one.

Specified by:

copyFieldLayoutScheme in interface FieldLayoutManager

getFieldConfigurationScheme

public FieldConfigurationScheme getFieldConfigurationScheme(Long schemeId)

Description copied from interface: FieldLayoutManager

Retrieves a FieldConfigurationScheme by id

Specified by:

getFieldConfigurationScheme in interface FieldLayoutManager

Parameters:

schemeId - FieldConfigurationScheme ID

Returns:

A FieldConfigurationScheme instance

getMutableFieldLayoutScheme

public FieldLayoutScheme getMutableFieldLayoutScheme(Long schemeId)

Description copied from interface: FieldLayoutManager

Retrieves a mutable FieldLayoutScheme by id.

This returns a new copy of the object from the DB, and so will incur some performance penalty. Please use FieldLayoutManager.getFieldConfigurationScheme(Long) for access to a cached immutable scheme object.

Specified by:

getMutableFieldLayoutScheme in interface FieldLayoutManager

Parameters:

schemeId - the scheme ID

Returns:

A FieldLayoutScheme instance

fieldConfigurationSchemeExists

public boolean fieldConfigurationSchemeExists(String schemeName)

Description copied from interface: FieldLayoutManager

Checks if a FieldConfigurationScheme with the given name exists.

Specified by:

fieldConfigurationSchemeExists in interface FieldLayoutManager

Parameters:

schemeName - The scheme name

Returns:

true if a FieldConfigurationScheme with the given name exists.

getUniqueFieldLayouts

public Set<FieldLayout> getUniqueFieldLayouts(Project project)

Description copied from interface: FieldLayoutManager

Retrieves all the FieldLayout's for a project.

Specified by:

getUniqueFieldLayouts in interface FieldLayoutManager

Parameters:

project - a project

Returns:

the unique set of FieldLayout's for the provided project, an empty set if there are none.

getUniqueFieldLayouts

@Nonnull
public Set<FieldLayout> getUniqueFieldLayouts(@Nonnull
 Collection<Project> projects,
 @Nonnull
 Collection<String> issueTypeIds)

Description copied from interface: FieldLayoutManager

Retrieves all the FieldLayout's for a collection of projects and issue types.

Specified by:

getUniqueFieldLayouts in interface FieldLayoutManager

Parameters:

projects - a collection of projects.

issueTypeIds - An collection of issue type ids.

Returns:

the unique set of FieldLayout's for the provided projects, an empty set if there are none.

getFieldConfigurationScheme

public FieldConfigurationScheme getFieldConfigurationScheme(Project project)

Description copied from interface: FieldLayoutManager

Retrieves the Field Configuration Scheme associated with the supplied project.

Specified by:

getFieldConfigurationScheme in interface FieldLayoutManager

Parameters:

project - A project

Returns:

A FieldConfigurationScheme or null if none exists.

getFieldConfigurationSchemeForProject

public FieldConfigurationScheme getFieldConfigurationSchemeForProject(@Nonnull
 Long projectId)

Description copied from interface: FieldLayoutManager

Retrieves the Field Configuration Scheme associated with the supplied project.

Specified by:

getFieldConfigurationSchemeForProject in interface FieldLayoutManager

Parameters:

projectId - The project ID

Returns:

A FieldConfigurationScheme or null if none exists.

addSchemeAssociation

public void addSchemeAssociation(org.ofbiz.core.entity.GenericValue project,
 Long fieldLayoutSchemeId)

Description copied from interface: FieldLayoutManager

Associates a FieldLayoutScheme to the project supplied.

Specified by:

addSchemeAssociation in interface FieldLayoutManager

Parameters:

project - A project GenericValue

fieldLayoutSchemeId - ID of the FieldLayoutScheme

addSchemeAssociation

public void addSchemeAssociation(Project project,
 Long fieldLayoutSchemeId)

Description copied from interface: FieldLayoutManager

Associates a FieldLayoutScheme to the project supplied.

Specified by:

addSchemeAssociation in interface FieldLayoutManager

Parameters:

project - The project

fieldLayoutSchemeId - ID of the FieldLayoutScheme

removeSchemeAssociation

public void removeSchemeAssociation(org.ofbiz.core.entity.GenericValue project,
 Long fieldLayoutSchemeId)

Description copied from interface: FieldLayoutManager

Removes an association between a particular project and field configuration scheme.

Specified by:

removeSchemeAssociation in interface FieldLayoutManager

Parameters:

project - A project GenericValue

fieldLayoutSchemeId - The fieldLayoutScheme ID

removeSchemeAssociation

public void removeSchemeAssociation(Project project,
 Long fieldLayoutSchemeId)

Description copied from interface: FieldLayoutManager

Removes an association between a particular project and field configuration scheme.

Specified by:

removeSchemeAssociation in interface FieldLayoutManager

Parameters:

project - The project

fieldLayoutSchemeId - The fieldLayoutScheme ID

getFieldLayout

public FieldLayout getFieldLayout(Long id)

Description copied from interface: FieldLayoutManager

Used to retrieve FieldLayout information when rendering a screen given the id of the field layout. If the ID is null, the default layout is returned.

Specified by:

getFieldLayout in interface FieldLayoutManager

Parameters:

id - The FieldLayout ID.

Returns:

The FieldLayout

refresh

public void refresh()

Description copied from interface: FieldLayoutManager

Clears all local caches.

Specified by:

refresh in interface FieldLayoutManager

Overrides:

refresh in class AbstractFieldLayoutManager

clearCaches

protected void clearCaches()

isFieldLayoutSchemesVisiblyEquivalent

public boolean isFieldLayoutSchemesVisiblyEquivalent(Long fieldConfigurationSchemeId1,
 Long fieldConfigurationSchemeId2)

Description copied from interface: FieldLayoutManager

Will determine whether or not two FieldLayoutSchemes are "visibly equivalent".

This can be useful for determining if swapping one field layout scheme for another in a project will have any affect on the visibility of fields in the project's issues. For instance, this will let us know if we need to re-index or not.

Since a scheme is a mapping from issue types to field layouts, two schemes are visibly equivalent if:

• All issue types map to the same field layouts; or else
• The field layouts that an issue type is associated with in each scheme are visibly equivalent

It is possible that one scheme may have a mapping for an issue type, but the other does not. In this case, equivalence is compared between the issue type specific one and the default field layout.

Note that equivalence is reflexive - all the associations in scheme1 must have equivalent associations in scheme2, and vice versa.

Specified by:

isFieldLayoutSchemesVisiblyEquivalent in interface FieldLayoutManager

Parameters:

fieldConfigurationSchemeId1 - the first scheme; can use null for the system default scheme

fieldConfigurationSchemeId2 - the second scheme; can use null for the system default scheme

Returns:

the result of the equivalence comparison

isFieldLayoutsVisiblyEquivalent

public boolean isFieldLayoutsVisiblyEquivalent(Long fieldLayoutId1,
 Long fieldLayoutId2)

Description copied from interface: FieldLayoutManager

Will determine whether or not two FieldLayouts are "visibly equivalent".

This can be useful for determining if swapping one field layout for another in a project will have any affect on the visibility of fields in the project's issues. For instance, this will let us know if we need to re-index or not.

Two field layouts are visibly equivalent if:

• They contain the same fields, and
• Each field has the same shown/hidden flag

Note that equivalence is reflexive: layout1 == layout2 implies layout2 == layout1.

Specified by:

isFieldLayoutsVisiblyEquivalent in interface FieldLayoutManager

Parameters:

fieldLayoutId1 - the first layout id; null signifies the default field layout in the system

fieldLayoutId2 - the second layout id; null signifies the default field layout in the system

Returns:

the result of the equivalence comparison

updateFieldLayoutItemAttributesForCustomField

public void updateFieldLayoutItemAttributesForCustomField(@Nonnull
 CustomField customField,
 @Nonnull
 String description,
 boolean isRequired,
 boolean isHidden)

Description copied from interface: FieldLayoutManager

Update the description, isHidden and isRequired columns of all the fieldlayoutitem rows associated with this custom field.

Specified by:

updateFieldLayoutItemAttributesForCustomField in interface FieldLayoutManager

Parameters:

customField - a CustomField which owns the affected fieldlayoutitems

description - a String containing the new description

isRequired - a boolean containing the new value

isHidden - a boolean containing the new value.

getAllRelevantIssueTypeIds

protected List<String> getAllRelevantIssueTypeIds()