com.atlassian.jira.issue.fields.layout.column
Class DefaultColumnLayoutManager

java.lang.Object
  com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager
      com.atlassian.jira.issue.fields.layout.column.DefaultColumnLayoutManager

All Implemented Interfaces:

ColumnLayoutManager

public class DefaultColumnLayoutManager
extends AbstractColumnLayoutManager

Field Summary

Fields inherited from class com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager

DEFAULT_CACHE_SIZE, ofBizDelegator

Constructor Summary

DefaultColumnLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, UserKeyService userKeyService)

Method Summary

ColumnLayout	getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser, SearchRequest searchRequest) Get the columns layout for a searchRequest, if the searchRequest does not have one the user's columns are returned.
protected com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager.CacheableColumnLayout	getColumnLayoutItems(String username, SearchRequest searchRequest, Set<NavigableField> availableFields)
EditableSearchRequestColumnLayout	getEditableSearchRequestColumnLayout(com.atlassian.crowd.embedded.api.User user, SearchRequest searchRequest) Get an editable column layout for the searchRequest, returns null if it does not have one
boolean	hasColumnLayout(Long filterId) Tells whether the filter with the given id has columns configured.
boolean	hasColumnLayout(SearchRequest searchRequest) Tells whether the given filter has columns configured.
boolean	hasColumnLayout(com.atlassian.crowd.embedded.api.User user) Tells whether the given user has a column layout.
boolean	hasDefaultColumnLayout() Tells whether the system has a default column layout object in the persistent store.
void	onClearCache(ClearCacheEvent event)
void	refresh()
void	restoreSearchRequestColumnLayout(SearchRequest searchRequest)
void	storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout) Writes the default column layout to permanent storage

Methods inherited from class com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager

getColumnLayout, getDefaultColumnLayout, getDefaultColumnLayout, getEditableDefaultColumnLayout, getEditableUserColumnLayout, restoreDefaultColumnLayout, restoreUserColumnLayout, storeColumnLayoutItems, storeEditableDefaultColumnLayout, storeEditableUserColumnLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultColumnLayoutManager

public DefaultColumnLayoutManager(FieldManager fieldManager,
                                  OfBizDelegator ofBizDelegator,
                                  UserKeyService userKeyService)

Method Detail

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getColumnLayout

public ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser,
                                    SearchRequest searchRequest)
                             throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Get the columns layout for a searchRequest, if the searchRequest does not have one the user's columns are returned. If the user does not have one the default is returned

Returns:

Immutable ColumnLayout to be used when displaying

Throws:

ColumnLayoutStorageException

getColumnLayoutItems

protected com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager.CacheableColumnLayout getColumnLayoutItems(String username,
                                                                                                                               SearchRequest searchRequest,
                                                                                                                               Set<NavigableField> availableFields)

getEditableSearchRequestColumnLayout

public EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(com.atlassian.crowd.embedded.api.User user,
                                                                              SearchRequest searchRequest)

Description copied from interface: ColumnLayoutManager

Get an editable column layout for the searchRequest, returns null if it does not have one

Returns:

EditableColumnLayout if there is one for the searchRequest otherwise return a new one generated from the default

storeEditableSearchRequestColumnLayout

public void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)

Description copied from interface: ColumnLayoutManager

Writes the default column layout to permanent storage

restoreSearchRequestColumnLayout

public void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
                                      throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

hasColumnLayout

public boolean hasColumnLayout(SearchRequest searchRequest)

Description copied from interface: ColumnLayoutManager

Tells whether the given filter has columns configured.

Returns:

true only if the filter has a column layout.

hasColumnLayout

public boolean hasColumnLayout(Long filterId)

Description copied from interface: ColumnLayoutManager

Tells whether the filter with the given id has columns configured.

Returns:

true only if there is a filter with the id and its has a column layout.

refresh

public void refresh()

Specified by:

refresh in interface ColumnLayoutManager

Overrides:

refresh in class AbstractColumnLayoutManager

hasColumnLayout

public boolean hasColumnLayout(com.atlassian.crowd.embedded.api.User user)

Description copied from interface: ColumnLayoutManager

Tells whether the given user has a column layout.

Returns:

true only if the given user has a column layout.

hasDefaultColumnLayout

public boolean hasDefaultColumnLayout()
                               throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Tells whether the system has a default column layout object in the persistent store.

Returns:

true only if there is a default column layout.

Throws:

ColumnLayoutStorageException - when the persistent store is inaccessible.