public class

DefaultColumnLayoutManager

extends Object
implements ColumnLayoutManager
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.layout.column.DefaultColumnLayoutManager

Summary

Public Constructors
DefaultColumnLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, UserKeyService userKeyService, CacheManager cacheManager)
Public Methods
ColumnLayout getColumnLayout(ApplicationUser remoteUser)
Get the columns layout for a user, if the user does not have one the default is returned
ColumnLayout getColumnLayout(ApplicationUser remoteUser, SearchRequest searchRequest)
Get the columns layout for a searchRequest, if the searchRequest does not have one the user's columns are returned.
ColumnLayout getDefaultColumnLayout()
ColumnLayout getDefaultColumnLayout(ApplicationUser remoteUser)
Get the default Layout, and filter out the columns which a user cannot see
EditableDefaultColumnLayout getEditableDefaultColumnLayout()
Get an editable default column layout for the system
EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(ApplicationUser user, SearchRequest searchRequest)
Get an editable column layout for the searchRequest, returns null if it does not have one
EditableUserColumnLayout getEditableUserColumnLayout(ApplicationUser user)
Get an editable column layout for the user, returns null if they do 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(ApplicationUser 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.
@EventListener void onClearCache(ClearCacheEvent event)
void refresh()
void restoreDefaultColumnLayout()
Sets the ColumnLayout in use for users who have not defined their own, also known as the System column layout.
void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
void restoreUserColumnLayout(ApplicationUser user)
void storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout)
Writes the default column layout to permanent storage
void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)
Writes the default column layout to permanent storage
void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout)
Writes the default column layout to permanent storage
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.layout.column.ColumnLayoutManager

Public Constructors

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

Public Methods

public ColumnLayout getColumnLayout (ApplicationUser remoteUser)

Get the columns layout for a user, if the user does not have one the default is returned

Returns
  • Immutable ColumnLayout to be used when displaying
Throws
ColumnLayoutStorageException

public ColumnLayout getColumnLayout (ApplicationUser remoteUser, SearchRequest searchRequest)

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

public ColumnLayout getDefaultColumnLayout ()

Throws
ColumnLayoutStorageException

public ColumnLayout getDefaultColumnLayout (ApplicationUser remoteUser)

Get the default Layout, and filter out the columns which a user cannot see

Throws
ColumnLayoutStorageException

public EditableDefaultColumnLayout getEditableDefaultColumnLayout ()

Get an editable default column layout for the system

public EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout (ApplicationUser user, SearchRequest searchRequest)

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

public EditableUserColumnLayout getEditableUserColumnLayout (ApplicationUser user)

Get an editable column layout for the user, returns null if they do not have one

Returns
  • EditableColumnLayout if there is one for the user otherwise return a new one generated from the default

public boolean hasColumnLayout (Long filterId)

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.

public boolean hasColumnLayout (SearchRequest searchRequest)

Tells whether the given filter has columns configured.

Returns
  • true only if the filter has a column layout.

public boolean hasColumnLayout (ApplicationUser user)

Tells whether the given user has a column layout.

Returns
  • true only if the given user has a column layout.

public boolean hasDefaultColumnLayout ()

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

@EventListener public void onClearCache (ClearCacheEvent event)

public void refresh ()

public void restoreDefaultColumnLayout ()

Sets the ColumnLayout in use for users who have not defined their own, also known as the System column layout.

public void restoreSearchRequestColumnLayout (SearchRequest searchRequest)

Throws
ColumnLayoutStorageException

public void restoreUserColumnLayout (ApplicationUser user)

public void storeEditableDefaultColumnLayout (EditableDefaultColumnLayout editableDefaultColumnLayout)

Writes the default column layout to permanent storage

Throws
ColumnLayoutStorageException

public void storeEditableSearchRequestColumnLayout (EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)

Writes the default column layout to permanent storage

public void storeEditableUserColumnLayout (EditableUserColumnLayout editableUserColumnLayout)

Writes the default column layout to permanent storage

Throws
ColumnLayoutStorageException