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

Interface ColumnLayout

All Known Subinterfaces:

EditableColumnLayout, EditableDefaultColumnLayout, EditableSearchRequestColumnLayout, EditableUserColumnLayout, UserColumnLayout

All Known Implementing Classes:

ColumnLayoutImpl, DefaultColumnLayoutImpl, EditableColumnLayoutImpl, EditableDefaultColumnLayoutImpl, EditableSearchRequestColumnLayoutImpl, EditableUserColumnLayoutImpl, UserColumnLayoutImpl

@PublicApi
public interface ColumnLayout

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ColumnLayout.ColumnConfig Represents the cause or source of columns in an issue table, e.g.

Method Summary

Modifier and Type	Method and Description
List<String>	asFieldNames()
boolean	contains(NavigableField navigableField)
List<ColumnLayoutItem>	getAllVisibleColumnLayoutItems(ApplicationUser user) Get the ColumnLayoutItems that can be displayed to the user.
ColumnLayout.ColumnConfig	getColumnConfig()
List<ColumnLayoutItem>	getColumnLayoutItems()
List<ColumnLayoutItem>	getVisibleColumnLayoutItems(ApplicationUser user, QueryContext queryContext) Deprecated. Current implementation of this method is not very good performance wise. Use getColumnLayoutItems() instead. Since 6.3.3

Method Detail

getColumnLayoutItems

List<ColumnLayoutItem> getColumnLayoutItems()

getVisibleColumnLayoutItems

@Deprecated
List<ColumnLayoutItem> getVisibleColumnLayoutItems(ApplicationUser user,
                                                               QueryContext queryContext)
                                                        throws ColumnLayoutException

Deprecated. Current implementation of this method is not very good performance wise. Use getColumnLayoutItems() instead. Since 6.3.3

Get the ColumnLayoutItems that can be displayed to the user.

Parameters:

user - the user for whom the columns are to be displayed.

queryContext - the context of the search the columns are being displayed for

Returns:

All visible column layout items for the given query context

Throws:

ColumnLayoutException - if exception thrown while retreiving column layout

getAllVisibleColumnLayoutItems

List<ColumnLayoutItem> getAllVisibleColumnLayoutItems(ApplicationUser user)
                                               throws ColumnLayoutException

Get the ColumnLayoutItems that can be displayed to the user.

Parameters:

user - the user for whom the columns are to be displayed.

Returns:

All visible column layout items

Throws:

ColumnLayoutException - if exception thrown while retreiving column layout

contains

boolean contains(NavigableField navigableField)

asFieldNames

List<String> asFieldNames()

Returns:

the column layout items as a list of string

getColumnConfig

ColumnLayout.ColumnConfig getColumnConfig()

Returns:

the columns used when creating the ColumnLayout