@PublicApi
public interface ColumnLayoutManager
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.Modifier and Type | Method and Description |
---|---|
ColumnLayout |
getColumnLayout(com.atlassian.crowd.embedded.api.User user)
Get the columns layout for a user, if the user does not have one the default is returned
|
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.
|
ColumnLayout |
getDefaultColumnLayout() |
ColumnLayout |
getDefaultColumnLayout(com.atlassian.crowd.embedded.api.User 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(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
|
EditableUserColumnLayout |
getEditableUserColumnLayout(com.atlassian.crowd.embedded.api.User 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(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 |
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(com.atlassian.crowd.embedded.api.User 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
|
boolean hasDefaultColumnLayout() throws ColumnLayoutStorageException
ColumnLayoutStorageException
- when the persistent store is inaccessible.boolean hasColumnLayout(com.atlassian.crowd.embedded.api.User user) throws ColumnLayoutStorageException
ColumnLayoutStorageException
- when the persistent store is inaccessible.boolean hasColumnLayout(SearchRequest searchRequest) throws ColumnLayoutStorageException
filter
has columns configured.ColumnLayoutStorageException
- when the persistent store is inaccessible.boolean hasColumnLayout(Long filterId) throws ColumnLayoutStorageException
ColumnLayoutStorageException
- when the persistent store is inaccessible.ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User user) throws ColumnLayoutStorageException
ColumnLayoutStorageException
ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser, SearchRequest searchRequest) throws ColumnLayoutStorageException
ColumnLayoutStorageException
EditableDefaultColumnLayout getEditableDefaultColumnLayout() throws ColumnLayoutStorageException
ColumnLayoutStorageException
EditableUserColumnLayout getEditableUserColumnLayout(com.atlassian.crowd.embedded.api.User user) throws ColumnLayoutStorageException
ColumnLayoutStorageException
EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(com.atlassian.crowd.embedded.api.User user, SearchRequest searchRequest) throws ColumnLayoutStorageException
ColumnLayoutStorageException
void storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout) throws ColumnLayoutStorageException
ColumnLayoutStorageException
void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout) throws ColumnLayoutStorageException
ColumnLayoutStorageException
void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout) throws ColumnLayoutStorageException
ColumnLayoutStorageException
void restoreDefaultColumnLayout() throws ColumnLayoutStorageException
ColumnLayoutStorageException
- if the persistent store is inaccessible.void restoreUserColumnLayout(com.atlassian.crowd.embedded.api.User user) throws ColumnLayoutStorageException
ColumnLayoutStorageException
void restoreSearchRequestColumnLayout(SearchRequest searchRequest) throws ColumnLayoutStorageException
ColumnLayoutStorageException
ColumnLayout getDefaultColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser) throws ColumnLayoutStorageException
ColumnLayoutStorageException
ColumnLayout getDefaultColumnLayout() throws ColumnLayoutStorageException
ColumnLayoutStorageException
void refresh()
Copyright © 2002-2015 Atlassian. All Rights Reserved.