@PublicApi public interface

ColumnLayout

com.atlassian.jira.issue.fields.layout.column.ColumnLayout
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

Nested Classes
enum ColumnLayout.ColumnConfig Represents the cause or source of columns in an issue table, e.g. 
Public Methods
List<String> asFieldNames()
boolean contains(NavigableField navigableField)
List<ColumnLayoutItem> getAllVisibleColumnLayoutItems(User user)
Get the ColumnLayoutItems that can be displayed to the user.
ColumnLayout.ColumnConfig getColumnConfig()
List<ColumnLayoutItem> getColumnLayoutItems()
List<ColumnLayoutItem> getVisibleColumnLayoutItems(User user, QueryContext queryContext)
Get the ColumnLayoutItems that can be displayed to the user.

Public Methods

public List<String> asFieldNames ()

Returns
  • the column layout items as a list of string

public boolean contains (NavigableField navigableField)

public List<ColumnLayoutItem> getAllVisibleColumnLayoutItems (User user)

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

public ColumnLayout.ColumnConfig getColumnConfig ()

Returns
  • the columns used when creating the ColumnLayout

public List<ColumnLayoutItem> getColumnLayoutItems ()

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

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