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

Interface ColumnLayoutManager

All Known Implementing Classes:

DefaultColumnLayoutManager

@PublicApi
public interface ColumnLayoutManager

Provides access to persistence services for ColumnLayout objects for system-wide Issue Navigator default columns, user default columns and columns for Filter Filters.

Plugin authors should prefer to use ColumnService where possible instead as that provides high level i18n and permission aspects.

Method Summary

Modifier and Type	Method and Description
ColumnLayout	getColumnLayout(ApplicationUser user) 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(ApplicationUser user) Tells whether the given user has a column layout.
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	hasDefaultColumnLayout() Tells whether the system has a default column layout object in the persistent store.
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

Method Detail

hasDefaultColumnLayout

boolean hasDefaultColumnLayout()
                        throws ColumnLayoutStorageException

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.

hasColumnLayout

boolean hasColumnLayout(ApplicationUser user)
                 throws ColumnLayoutStorageException

Tells whether the given user has a column layout.

Returns:

true only if the given user has a column layout.

Throws:

ColumnLayoutStorageException - when the persistent store is inaccessible.

hasColumnLayout

boolean hasColumnLayout(SearchRequest searchRequest)
                 throws ColumnLayoutStorageException

Tells whether the given filter has columns configured.

Returns:

true only if the filter has a column layout.

Throws:

ColumnLayoutStorageException - when the persistent store is inaccessible.

hasColumnLayout

boolean hasColumnLayout(Long filterId)
                 throws ColumnLayoutStorageException

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.

Throws:

ColumnLayoutStorageException - when the persistent store is inaccessible.

getColumnLayout

ColumnLayout getColumnLayout(ApplicationUser user)
                      throws ColumnLayoutStorageException

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

getColumnLayout

ColumnLayout getColumnLayout(ApplicationUser remoteUser,
                             SearchRequest searchRequest)
                      throws ColumnLayoutStorageException

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

getEditableDefaultColumnLayout

EditableDefaultColumnLayout getEditableDefaultColumnLayout()
                                                    throws ColumnLayoutStorageException

Get an editable default column layout for the system

Throws:

ColumnLayoutStorageException

getEditableUserColumnLayout

EditableUserColumnLayout getEditableUserColumnLayout(ApplicationUser user)
                                              throws ColumnLayoutStorageException

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

Throws:

ColumnLayoutStorageException

getEditableSearchRequestColumnLayout

EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(ApplicationUser user,
                                                                       SearchRequest searchRequest)
                                                                throws ColumnLayoutStorageException

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

Throws:

ColumnLayoutStorageException

storeEditableDefaultColumnLayout

void storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout)
                               throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Throws:

ColumnLayoutStorageException

storeEditableUserColumnLayout

void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout)
                            throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Throws:

ColumnLayoutStorageException

storeEditableSearchRequestColumnLayout

void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)
                                     throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Throws:

ColumnLayoutStorageException

restoreDefaultColumnLayout

void restoreDefaultColumnLayout()
                         throws ColumnLayoutStorageException

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

Throws:

ColumnLayoutStorageException - if the persistent store is inaccessible.

restoreUserColumnLayout

void restoreUserColumnLayout(ApplicationUser user)
                      throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

restoreSearchRequestColumnLayout

void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
                               throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

ColumnLayout getDefaultColumnLayout(ApplicationUser remoteUser)
                             throws ColumnLayoutStorageException

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

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

ColumnLayout getDefaultColumnLayout()
                             throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

refresh

void refresh()