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

java.lang.Object
  com.atlassian.jira.issue.fields.layout.field.AbstractFieldLayoutManager

All Implemented Interfaces:

Startable, FieldLayoutManager

Direct Known Subclasses:

DefaultFieldLayoutManager

public abstract class AbstractFieldLayoutManager
extends Object
implements FieldLayoutManager, Startable

Field Summary

protected OfBizDelegator	ofBizDelegator
static String	SCHEME
static String	SCHEME_ASSOCIATION

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

TYPE_DEFAULT

Constructor Summary

AbstractFieldLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, I18nHelper.BeanFactory i18n, com.atlassian.cache.CacheManager cacheManager)

Method Summary

protected String	getDefaultDescription(String fieldId)
protected List<FieldLayoutItem>	getDefaultFieldLayoutItems()
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.
protected I18nHelper	getI18nHelper()
protected FieldLayout	getRelevantFieldLayout(Long id) Retrieves the field layout given a given id.
boolean	hasDefaultFieldLayout() Checks to see if a FieldLayout entity with type FieldLayoutManager.TYPE_DEFAULT exists
void	onCustomFieldUpdated(CustomFieldUpdatedEvent event)
void	refresh() Clears all local caches.
protected void	refreshCaches(Long id)
void	restoreDefaultFieldLayout() This method can be used to rollback any changes to the default field configuration.
protected void	restoreFieldLayout(Long id)
void	start() This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.
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.

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

addSchemeAssociation, addSchemeAssociation, copyFieldLayoutScheme, createFieldLayoutScheme, createFieldLayoutScheme, createFieldLayoutSchemeEntity, createFieldLayoutSchemeEntity, deleteFieldLayout, deleteFieldLayoutScheme, fieldConfigurationSchemeExists, getEditableFieldLayout, getEditableFieldLayouts, getFieldConfigurationScheme, getFieldConfigurationScheme, getFieldConfigurationScheme, getFieldConfigurationSchemes, getFieldLayout, getFieldLayout, getFieldLayout, getFieldLayout, getFieldLayoutSchemeEntities, getFieldLayoutSchemes, getMutableFieldLayoutScheme, getProjects, getProjects, getRelatedProjects, getUniqueFieldLayouts, isFieldLayoutSchemesVisiblyEquivalent, isFieldLayoutsVisiblyEquivalent, removeFieldLayoutScheme, removeFieldLayoutSchemeEntity, removeSchemeAssociation, removeSchemeAssociation, restoreSchemeFieldLayout, updateFieldLayoutScheme, updateFieldLayoutSchemeEntity

Field Detail

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

SCHEME_ASSOCIATION

public static final String SCHEME_ASSOCIATION

See Also:

Constant Field Values

ofBizDelegator

protected OfBizDelegator ofBizDelegator

Constructor Detail

AbstractFieldLayoutManager

public AbstractFieldLayoutManager(FieldManager fieldManager,
                                  OfBizDelegator ofBizDelegator,
                                  I18nHelper.BeanFactory i18n,
                                  com.atlassian.cache.CacheManager cacheManager)

Method Detail

start

public void start()
           throws Exception

Description copied from interface: Startable

This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

Throws:

Exception - Allows implementations to throw an Exception.

onCustomFieldUpdated

@EventListener
public void onCustomFieldUpdated(CustomFieldUpdatedEvent event)

getDefaultFieldLayoutItems

protected List<FieldLayoutItem> getDefaultFieldLayoutItems()

getFieldLayout

public FieldLayout getFieldLayout()

Description copied from interface: FieldLayoutManager

Used to retrieve FieldLayout information when rendering a screen.

Specified by:

getFieldLayout in interface FieldLayoutManager

Returns:

the default FieldLayout

getFieldLayout

public FieldLayout getFieldLayout(Issue issue)

Description copied from interface: FieldLayoutManager

Returns the fieldLayout for an issue.

Specified by:

getFieldLayout in interface FieldLayoutManager

Parameters:

issue - An Issue

Returns:

A FieldLayout

getEditableDefaultFieldLayout

public EditableDefaultFieldLayout getEditableDefaultFieldLayout()

Description copied from interface: FieldLayoutManager

Returns the default EditableDefaultFieldLayout.

Specified by:

getEditableDefaultFieldLayout in interface FieldLayoutManager

Returns:

the default EditableDefaultFieldLayout.

storeEditableDefaultFieldLayout

public void storeEditableDefaultFieldLayout(EditableDefaultFieldLayout editableDefaultFieldLayout)

Description copied from interface: FieldLayoutManager

Persist the given default EditableDefaultFieldLayout

Specified by:

storeEditableDefaultFieldLayout in interface FieldLayoutManager

Parameters:

editableDefaultFieldLayout - The EditableDefaultFieldLayout.

storeAndReturnEditableFieldLayout

public EditableFieldLayout storeAndReturnEditableFieldLayout(EditableFieldLayout editableFieldLayout)

Description copied from interface: FieldLayoutManager

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

Specified by:

storeAndReturnEditableFieldLayout in interface FieldLayoutManager

Parameters:

editableFieldLayout - the EditableFieldLayout.

Returns:

the layout as stored in the database.

storeEditableFieldLayout

public void storeEditableFieldLayout(EditableFieldLayout editableFieldLayout)

Description copied from interface: FieldLayoutManager

Persists the EditableFieldLayout provided.

Specified by:

storeEditableFieldLayout in interface FieldLayoutManager

Parameters:

editableFieldLayout - the EditableFieldLayout.

refreshCaches

protected void refreshCaches(Long id)

hasDefaultFieldLayout

public boolean hasDefaultFieldLayout()

Description copied from interface: FieldLayoutManager

Checks to see if a FieldLayout entity with type FieldLayoutManager.TYPE_DEFAULT exists

Specified by:

hasDefaultFieldLayout in interface FieldLayoutManager

Returns:

True if a default FieldLayout exists, false otherwise.

restoreDefaultFieldLayout

public void restoreDefaultFieldLayout()

Description copied from interface: FieldLayoutManager

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

Specified by:

restoreDefaultFieldLayout in interface FieldLayoutManager

restoreFieldLayout

protected void restoreFieldLayout(Long id)

refresh

public void refresh()

Description copied from interface: FieldLayoutManager

Clears all local caches.

Specified by:

refresh in interface FieldLayoutManager

getRelevantFieldLayout

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

getDefaultDescription

protected String getDefaultDescription(String fieldId)

getI18nHelper

protected I18nHelper getI18nHelper()