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

public interface ColumnLayout

Method Summary

boolean	contains(NavigableField navigableField)
List<ColumnLayoutItem>	getAllVisibleColumnLayoutItems(User user) Get the ColumnLayoutItems that can be displayed to the user.
List<ColumnLayoutItem>	getColumnLayoutItems()
List<ColumnLayoutItem>	getVisibleColumnLayoutItems(User user, QueryContext queryContext) Get the ColumnLayoutItems that can be displayed to the user.

Method Detail

getColumnLayoutItems

List<ColumnLayoutItem> getColumnLayoutItems()

getVisibleColumnLayoutItems

List<ColumnLayoutItem> getVisibleColumnLayoutItems(User user,
                                                   QueryContext queryContext)
                                                   throws ColumnLayoutException

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(User 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)