Summary: Methods | [Expand All]
public interface

ColumnService

com.atlassian.jira.bc.issue.fields.ColumnService
Known Indirect Subclasses

Class Overview

Provides access and manipulation of column configuration for filters and default column configuration for users.

Summary

Public Methods
ServiceOutcome<ColumnLayout> getColumnLayout(ApplicationUser serviceUser, ApplicationUser userWithColumns)
Retreive the effective ColumnLayout for userWithColumns.
ServiceOutcome<ColumnLayout> getColumnLayout(ApplicationUser serviceUser, Long filterId)
Get the column layout for the given filter.
ServiceOutcome<ColumnLayout> getDefaultColumnLayout(ApplicationUser serviceUser)
Get the system's default columns.
ServiceResult resetColumns(ApplicationUser serviceUser, Long filterId)
Resets the given filter to no longer have its own ColumnLayout.
ServiceResult resetColumns(ApplicationUser serviceUser, ApplicationUser userWithColumns)
Resets a user's ColumnLayout.
ServiceResult setColumns(ApplicationUser serviceUser, Long filterId, List<String> fieldIds)
Sets the given filter ColumnLayout to the given fields.
ServiceResult setColumns(ApplicationUser serviceUser, ApplicationUser userWithColumns, List<String> fieldIds)
Sets a user's ColumnLayout.
ServiceResult setDefaultColumns(ApplicationUser serviceUser, List<String> fieldIds)
Sets the system's default columns to the given fieldIds

Public Methods

public ServiceOutcome<ColumnLayout> getColumnLayout (ApplicationUser serviceUser, ApplicationUser userWithColumns)

Retreive the effective ColumnLayout for userWithColumns. Users may not have set their default columns in which case they will be seeing the system's default columns. In that case the outcome contain the default columns.

Parameters
serviceUser for this service request.
userWithColumns the user whose columns are being requested.
Returns

public ServiceOutcome<ColumnLayout> getColumnLayout (ApplicationUser serviceUser, Long filterId)

Get the column layout for the given filter. If there is no column layout for the filter, the outcome will contain null.

Parameters
serviceUser for this service request.
filterId the id of the filter to get the column layout for.
Returns
  • the column layout or null.

public ServiceOutcome<ColumnLayout> getDefaultColumnLayout (ApplicationUser serviceUser)

Get the system's default columns.

Parameters
serviceUser for this service request. User must have admin access in order to perform this operation
Returns
  • the column layout or null.

public ServiceResult resetColumns (ApplicationUser serviceUser, Long filterId)

Resets the given filter to no longer have its own ColumnLayout.

Parameters
serviceUser for this service request
filterId id of the filter
Returns
  • com.atlassian.jira.bc.ServiceResult

public ServiceResult resetColumns (ApplicationUser serviceUser, ApplicationUser userWithColumns)

Resets a user's ColumnLayout.

Parameters
serviceUser for this service request.
userWithColumns the use whose columns are being reset.
Returns
  • com.atlassian.jira.bc.ServiceResult

public ServiceResult setColumns (ApplicationUser serviceUser, Long filterId, List<String> fieldIds)

Sets the given filter ColumnLayout to the given fields.

Parameters
serviceUser for this service request
filterId id of the filter
fieldIds the list of field ids to set as the filter's ColumnLayout
Returns
  • com.atlassian.jira.bc.ServiceResult

public ServiceResult setColumns (ApplicationUser serviceUser, ApplicationUser userWithColumns, List<String> fieldIds)

Sets a user's ColumnLayout.

Parameters
serviceUser for this service request.
userWithColumns the use whose columns are being set.
fieldIds the list of field ids to set as the user's ColumnLayout.
Returns
  • com.atlassian.jira.bc.ServiceResult

public ServiceResult setDefaultColumns (ApplicationUser serviceUser, List<String> fieldIds)

Sets the system's default columns to the given fieldIds

Parameters
serviceUser for this service request. User must have admin access in order to perform this operation
fieldIds the list of field ids to set as the system's default ColumnLayout
Returns
  • com.atlassian.jira.bc.ServiceResult