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

All Known Implementing Classes:

AbstractColumnLayoutManager, DefaultColumnLayoutManager

@PublicApi
public interface ColumnLayoutManager

Method Summary

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(SearchRequest searchRequest)
boolean	hasColumnLayout(com.atlassian.crowd.embedded.api.User user)
boolean	hasDefaultColumnLayout()
void	refresh()
void	restoreDefaultColumnLayout()
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

Method Detail

hasDefaultColumnLayout

boolean hasDefaultColumnLayout()
                               throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

hasColumnLayout

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

Throws:

ColumnLayoutStorageException

hasColumnLayout

boolean hasColumnLayout(SearchRequest searchRequest)
                        throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getColumnLayout

ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User user)
                             throws ColumnLayoutStorageException

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

Parameters:

user -

Returns:

Immutable ColumnLayout to be used when displaying

Throws:

ColumnLayoutStorageException

getColumnLayout

ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User 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 nto have one the default is returned

Parameters:

searchRequest -

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(com.atlassian.crowd.embedded.api.User user)
                                                     throws ColumnLayoutStorageException

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

Parameters:

user -

Returns:

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

Throws:

ColumnLayoutStorageException

getEditableSearchRequestColumnLayout

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

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

Parameters:

user -

searchRequest -

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

Parameters:

editableDefaultColumnLayout -

Throws:

ColumnLayoutStorageException

storeEditableUserColumnLayout

void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout)
                                   throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Parameters:

editableUserColumnLayout -

Throws:

ColumnLayoutStorageException

storeEditableSearchRequestColumnLayout

void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)
                                            throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Parameters:

editableSearchRequestColumnLayout -

Throws:

ColumnLayoutStorageException

restoreDefaultColumnLayout

void restoreDefaultColumnLayout()
                                throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

restoreUserColumnLayout

void restoreUserColumnLayout(com.atlassian.crowd.embedded.api.User user)
                             throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

restoreSearchRequestColumnLayout

void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
                                      throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

ColumnLayout getDefaultColumnLayout(com.atlassian.crowd.embedded.api.User 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()