Summary: Methods | [Expand All]
@PublicApi public interface

ColumnLayoutManager

com.atlassian.jira.issue.fields.layout.column.ColumnLayoutManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

Public Methods
ColumnLayout getColumnLayout(User user)
Get the columns layout for a user, if the user does not have one the default is returned
ColumnLayout getColumnLayout(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(User remoteUser)
Get the default Layout, and filter out the columns which a user cannot see
ColumnLayout getDefaultColumnLayout()
EditableDefaultColumnLayout getEditableDefaultColumnLayout()
Get an editable default column layout for the system
EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(User user, SearchRequest searchRequest)
Get an editable column layout for the searchRequest, returns null if it does not have one
EditableUserColumnLayout getEditableUserColumnLayout(User user)
Get an editable column layout for the user, returns null if they do not have one
boolean hasColumnLayout(SearchRequest searchRequest)
boolean hasColumnLayout(Long filterId)
boolean hasColumnLayout(User user)
boolean hasDefaultColumnLayout()
void refresh()
void restoreDefaultColumnLayout()
void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
void restoreUserColumnLayout(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

Public Methods

public ColumnLayout getColumnLayout (User user)

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 (User 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 nto have one the default is returned

Returns
  • Immutable ColumnLayout to be used when displaying
Throws
ColumnLayoutStorageException

public ColumnLayout getDefaultColumnLayout (User remoteUser)

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

Throws
ColumnLayoutStorageException

public ColumnLayout getDefaultColumnLayout ()

Throws
ColumnLayoutStorageException

public EditableDefaultColumnLayout getEditableDefaultColumnLayout ()

Get an editable default column layout for the system

Throws
ColumnLayoutStorageException

public EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout (User 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
Throws
ColumnLayoutStorageException

public EditableUserColumnLayout getEditableUserColumnLayout (User 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
Throws
ColumnLayoutStorageException

public boolean hasColumnLayout (SearchRequest searchRequest)

Throws
ColumnLayoutStorageException

public boolean hasColumnLayout (Long filterId)

Throws
ColumnLayoutStorageException

public boolean hasColumnLayout (User user)

Throws
ColumnLayoutStorageException

public boolean hasDefaultColumnLayout ()

Throws
ColumnLayoutStorageException

public void refresh ()

public void restoreDefaultColumnLayout ()

Throws
ColumnLayoutStorageException

public void restoreSearchRequestColumnLayout (SearchRequest searchRequest)

Throws
ColumnLayoutStorageException

public void restoreUserColumnLayout (User user)

Throws
ColumnLayoutStorageException

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

Throws
ColumnLayoutStorageException

public void storeEditableUserColumnLayout (EditableUserColumnLayout editableUserColumnLayout)

Writes the default column layout to permanent storage

Throws
ColumnLayoutStorageException