public abstract class

AbstractFieldLayoutManager

extends Object
implements FieldLayoutManager
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.layout.field.AbstractFieldLayoutManager
Known Direct Subclasses

Summary

Constants
String DESCRIPTION
String FIELD_LAYOUT
String NAME
String SCHEME
String SCHEME_ASSOCIATION
String TYPE
[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.fields.layout.field.FieldLayoutManager
Fields
protected final FieldManager fieldManager
protected final I18nHelper.BeanFactory i18nFactory
protected final OfBizDelegator ofBizDelegator
Public Constructors
AbstractFieldLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, I18nHelper.BeanFactory i18nFactory, CacheManager cacheManager, ApplicationProperties applicationProperties)
Public Methods
EditableDefaultFieldLayout getEditableDefaultFieldLayout()
Returns the default EditableDefaultFieldLayout.
FieldLayout getFieldLayout()
Used to retrieve FieldLayout information when rendering a screen.
FieldLayout getFieldLayout(Issue issue)
Returns the fieldLayout for an issue.
boolean hasDefaultFieldLayout()
Checks to see if a FieldLayout entity with type TYPE_DEFAULT exists
@EventListener void onCustomFieldUpdated(CustomFieldUpdatedEvent event)
void refresh()
Clears all local caches.
@EventListener void refreshCacheWhenUpdateAllowUnassignedOption(BooleanApplicationPropertySetEvent booleanApplicationPropertySetEvent)
void restoreDefaultFieldLayout()
This method can be used to rollback any changes to the default field configuration.
synchronized EditableFieldLayout storeAndReturnEditableFieldLayout(EditableFieldLayout editableFieldLayout)
Persists the EditableFieldLayout provided and returns a new instance as stored in the database.
void storeEditableDefaultFieldLayout(EditableDefaultFieldLayout editableDefaultFieldLayout)
Persist the given default EditableDefaultFieldLayout
void storeEditableFieldLayout(EditableFieldLayout editableFieldLayout)
Persists the EditableFieldLayout provided.
Protected Methods
String getDefaultDescription(String fieldId)
List<FieldLayoutItem> getDefaultFieldLayoutItems()
I18nHelper getI18nHelper()
FieldLayout getRelevantFieldLayout(Long id)
Retrieves the field layout given a given id.
void refreshCaches(Long id)
synchronized void restoreFieldLayout(Long id)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.layout.field.FieldLayoutManager

Constants

public static final String DESCRIPTION

Constant Value: "description"

public static final String FIELD_LAYOUT

Constant Value: "FieldLayout"

public static final String NAME

Constant Value: "name"

public static final String SCHEME

Constant Value: "FieldLayoutScheme"

public static final String SCHEME_ASSOCIATION

Constant Value: "ProjectFieldLayoutScheme"

public static final String TYPE

Constant Value: "type"

Fields

protected final FieldManager fieldManager

protected final I18nHelper.BeanFactory i18nFactory

protected final OfBizDelegator ofBizDelegator

Public Constructors

public AbstractFieldLayoutManager (FieldManager fieldManager, OfBizDelegator ofBizDelegator, I18nHelper.BeanFactory i18nFactory, CacheManager cacheManager, ApplicationProperties applicationProperties)

Public Methods

public EditableDefaultFieldLayout getEditableDefaultFieldLayout ()

Returns the default EditableDefaultFieldLayout.

Returns

public FieldLayout getFieldLayout ()

Used to retrieve FieldLayout information when rendering a screen.

Returns
  • the default FieldLayout

public FieldLayout getFieldLayout (Issue issue)

Returns the fieldLayout for an issue.

Parameters
issue An Issue
Returns

public boolean hasDefaultFieldLayout ()

Checks to see if a FieldLayout entity with type TYPE_DEFAULT exists

Returns

@EventListener public void onCustomFieldUpdated (CustomFieldUpdatedEvent event)

public void refresh ()

Clears all local caches.

@EventListener public void refreshCacheWhenUpdateAllowUnassignedOption (BooleanApplicationPropertySetEvent booleanApplicationPropertySetEvent)

public void restoreDefaultFieldLayout ()

This method can be used to rollback any changes to the default field configuration.

public synchronized EditableFieldLayout storeAndReturnEditableFieldLayout (EditableFieldLayout editableFieldLayout)

Persists the EditableFieldLayout provided and returns a new instance as stored in the database.

Parameters
editableFieldLayout the EditableFieldLayout.
Returns
  • the layout as stored in the database.

public void storeEditableDefaultFieldLayout (EditableDefaultFieldLayout editableDefaultFieldLayout)

Persist the given default EditableDefaultFieldLayout

Parameters
editableDefaultFieldLayout The EditableDefaultFieldLayout.

public void storeEditableFieldLayout (EditableFieldLayout editableFieldLayout)

Persists the EditableFieldLayout provided.

Parameters
editableFieldLayout the EditableFieldLayout.

Protected Methods

protected String getDefaultDescription (String fieldId)

protected List<FieldLayoutItem> getDefaultFieldLayoutItems ()

protected I18nHelper getI18nHelper ()

protected FieldLayout getRelevantFieldLayout (Long id)

Retrieves the field layout given a given id. If the id is null the default field layout is retrieved

Parameters
id field layout id
Returns
  • field layout

protected void refreshCaches (Long id)

protected synchronized void restoreFieldLayout (Long id)