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

All Known Implementing Classes:

DefaultColumnLayoutManager

public interface ColumnLayoutManager

Method Summary

ColumnLayout	getColumnLayout(com.opensymphony.user.User user) Get the columns layout for a user, if the user does not have one the default is returned
ColumnLayout	getColumnLayout(com.opensymphony.user.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.opensymphony.user.User remoteUser)
EditableDefaultColumnLayout	getEditableDefaultColumnLayout() Get an editable default column layout for the system
EditableSearchRequestColumnLayout	getEditableSearchRequestColumnLayout(com.opensymphony.user.User user, SearchRequest searchRequest) Get an editable column layout for the searchRequest, returns null if it does not have one
EditableUserColumnLayout	getEditableUserColumnLayout(com.opensymphony.user.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.opensymphony.user.User user)
boolean	hasDefaultColumnLayout()
void	refresh()
void	restoreDefaultColumnLayout()
void	restoreSearchRequestColumnLayout(SearchRequest searchRequest)
void	restoreUserColumnLayout(com.opensymphony.user.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

public boolean hasDefaultColumnLayout()
                               throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

hasColumnLayout

public boolean hasColumnLayout(com.opensymphony.user.User user)
                        throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

hasColumnLayout

public boolean hasColumnLayout(SearchRequest searchRequest)
                        throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getColumnLayout

public ColumnLayout getColumnLayout(com.opensymphony.user.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

public ColumnLayout getColumnLayout(com.opensymphony.user.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

public EditableDefaultColumnLayout getEditableDefaultColumnLayout()
                                                           throws ColumnLayoutStorageException

Get an editable default column layout for the system

Returns:

Throws:

ColumnLayoutStorageException

getEditableUserColumnLayout

public EditableUserColumnLayout getEditableUserColumnLayout(com.opensymphony.user.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

public EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(com.opensymphony.user.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

public void storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout)
                                      throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Parameters:

editableDefaultColumnLayout -

Throws:

ColumnLayoutStorageException

storeEditableUserColumnLayout

public void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout)
                                   throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Parameters:

editableUserColumnLayout -

Throws:

ColumnLayoutStorageException

storeEditableSearchRequestColumnLayout

public void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)
                                            throws ColumnLayoutStorageException

Writes the default column layout to permanent storage

Parameters:

editableSearchRequestColumnLayout -

Throws:

ColumnLayoutStorageException

restoreDefaultColumnLayout

public void restoreDefaultColumnLayout()
                                throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

restoreUserColumnLayout

public void restoreUserColumnLayout(com.opensymphony.user.User user)
                             throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

restoreSearchRequestColumnLayout

public void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
                                      throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

public ColumnLayout getDefaultColumnLayout(com.opensymphony.user.User remoteUser)
                                    throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

public ColumnLayout getDefaultColumnLayout()
                                    throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

refresh

public void refresh()