com.atlassian.jira.bc.issue.fields.screen

Interface FieldScreenService

All Known Implementing Classes:

DefaultFieldScreenService

@PublicApi
public interface FieldScreenService

Since:

v5.2

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Field>	addFieldToScreen(FieldScreenTabId tab, String fieldId, FieldScreenOperationContext context) Adds a new field to the given tab
ServiceOutcome<FieldScreenTab>	addTab(FieldScreenId screen, String tabName, FieldScreenOperationContext context) Creates and adds new tab for screen
ServiceOutcome<FieldScreen>	copy(FieldScreen screen, String copyName, String copyDescription, ApplicationUser loggedInUser) Creates a copy of the passed field screen assigning the passed name and description.
ServiceOutcome<List<FieldScreenTab>>	getAllTabs(FieldScreenId screen, FieldScreenOperationContext context) Returns a list of all tabs for the given screen
ServiceOutcome<List<OrderableField>>	getAvailableFieldsForScreen(FieldScreenId screen, FieldScreenOperationContext context) Gets all fields, that can be added to given screen.
ServiceOutcome<List<Field>>	getFieldsOnTab(FieldScreenTabId tab, FieldScreenOperationContext context) Gets all fields on given tab
ServiceOutcome<List<FieldWithShowWhenEmpty>>	getFieldsWithShowWhenEmpty(FieldScreenTabId tabId, FieldScreenOperationContext context) Get all fields for a FieldScreenTab with information if field should be shown when it has no value Can only be used within DC license or dev mode
ServiceOutcome<Boolean>	getIsFieldScreenDeletable(FieldScreenId screen, FieldScreenOperationContext context) Gets information whether field screen can be safely deleted
ServiceResult	moveField(FieldScreenLayoutItemId item, MoveFieldInfo moveInfo, FieldScreenOperationContext context) Moves field along the tab, according to instructed details
ServiceOutcome<FieldScreenTab>	moveTab(FieldScreenTabId tab, Integer position, FieldScreenOperationContext context) Moves tab position on given screen
ServiceResult	removeField(FieldScreenLayoutItemId item, FieldScreenOperationContext context) Removes a field from the tab and effectively from the screen
ServiceResult	removeTab(FieldScreenTabId tab, FieldScreenOperationContext context) Removes tab from screen
ServiceOutcome<FieldScreenTab>	renameTab(FieldScreenTabId tab, String newName, FieldScreenOperationContext context) Renames already existing tab on given screen
ServiceResult	updateShowWhenEmpty(FieldScreenLayoutItemId itemId, FieldScreenOperationContext context, boolean showWhenEmpty) Update showWhenEmpty indicator of given FieldScreenLayoutItemId Can only be used within DC license or dev mode

Method Detail

copy

ServiceOutcome<FieldScreen> copy(FieldScreen screen,
                                 String copyName,
                                 String copyDescription,
                                 ApplicationUser loggedInUser)

Creates a copy of the passed field screen assigning the passed name and description.

Parameters:

screen - screen to copy

copyName - name for the copied screen

copyDescription - description for the copied screen

loggedInUser - user performing the copy

Returns:

copy result

getAllTabs

@ExperimentalApi
ServiceOutcome<List<FieldScreenTab>> getAllTabs(FieldScreenId screen,
                                                                 FieldScreenOperationContext context)

Returns a list of all tabs for the given screen

Parameters:

screen - id of screen

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing a list of tabs, or errors in case operation being not allowed

Since:

v7.4

addTab

@ExperimentalApi
ServiceOutcome<FieldScreenTab> addTab(FieldScreenId screen,
                                                       String tabName,
                                                       FieldScreenOperationContext context)

Creates and adds new tab for screen

Parameters:

screen - id of screen

tabName - new name of a tab. Cannot be empty

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing freshly created tab, or errors in case of failed validation or permission checks

Since:

v7.4

renameTab

@ExperimentalApi
ServiceOutcome<FieldScreenTab> renameTab(FieldScreenTabId tab,
                                                          String newName,
                                                          FieldScreenOperationContext context)

Renames already existing tab on given screen

Parameters:

tab - id of a tab to be renamed

newName - a new name of a tab. Cannot be empty

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing renamed tab, or errors in case of failed validation or permission checks

Since:

v7.4

removeTab

@ExperimentalApi
ServiceResult removeTab(FieldScreenTabId tab,
                                         FieldScreenOperationContext context)

Removes tab from screen

Parameters:

tab - id of a tab to be removed

context - context in which current operation is being executed

Returns:

a ServiceResult indicating whether operation succeeded, or errors in case of failed validation

Since:

v7.4

moveTab

@ExperimentalApi
ServiceOutcome<FieldScreenTab> moveTab(FieldScreenTabId tab,
                                                        Integer position,
                                                        FieldScreenOperationContext context)

Moves tab position on given screen

Parameters:

tab - id of a tab to be moved

position - new position on the screen expressed as 0-based index

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing moved tab, or errors in case of failed validation or permission checks

Since:

v7.4

getFieldsOnTab

@ExperimentalApi
ServiceOutcome<List<Field>> getFieldsOnTab(FieldScreenTabId tab,
                                                            FieldScreenOperationContext context)

Gets all fields on given tab

Parameters:

tab - id of a tab

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing ordered list of all fields, or errors in case of failed validation or permission checks

Since:

v7.4

getAvailableFieldsForScreen

@ExperimentalApi
ServiceOutcome<List<OrderableField>> getAvailableFieldsForScreen(FieldScreenId screen,
                                                                                  FieldScreenOperationContext context)

Gets all fields, that can be added to given screen. I.e. ones that haven't already been added

Parameters:

screen - id of a screen

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing a list of addable fields, or errors in case of failed validation or permission checks

Since:

v7.4

removeField

@ExperimentalApi
ServiceResult removeField(FieldScreenLayoutItemId item,
                                           FieldScreenOperationContext context)

Removes a field from the tab and effectively from the screen

Parameters:

item - id of field to be removed

context - context in which current operation is being executed

Returns:

a ServiceResult indicating whether operation succeeded, or errors in case of failed validation

Since:

v7.4

moveField

@ExperimentalApi
ServiceResult moveField(FieldScreenLayoutItemId item,
                                         MoveFieldInfo moveInfo,
                                         FieldScreenOperationContext context)

Moves field along the tab, according to instructed details

Parameters:

item - id of field to be moved

moveInfo - an MoveFieldInfo instructing how the field should be moved

context - context in which current operation is being executed

Returns:

a ServiceResult indicating whether operation succeeded, or errors in case of failed validation

Since:

v7.4

addFieldToScreen

@ExperimentalApi
ServiceOutcome<Field> addFieldToScreen(FieldScreenTabId tab,
                                                        String fieldId,
                                                        FieldScreenOperationContext context)

Adds a new field to the given tab

Parameters:

tab - id of tab

fieldId - the field ID which is expected to be added

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing newly added field, or errors in case of failed validation or permission checks

Since:

v7.4

getIsFieldScreenDeletable

@ExperimentalApi
ServiceOutcome<Boolean> getIsFieldScreenDeletable(FieldScreenId screen,
                                                                   FieldScreenOperationContext context)

Gets information whether field screen can be safely deleted

Parameters:

screen - id of a screen

context - context in which current operation is being executed

Returns:

a ServiceOutcome containing boolean denoting if screen can be deleted or not

Since:

v8.19

getFieldsWithShowWhenEmpty

@ExperimentalApi
ServiceOutcome<List<FieldWithShowWhenEmpty>> getFieldsWithShowWhenEmpty(FieldScreenTabId tabId,
                                                                                         FieldScreenOperationContext context)

Get all fields for a FieldScreenTab with information if field should be shown when it has no value Can only be used within DC license or dev mode

Parameters:

tabId - id of a tab

context - context in which current operation is being executed

Returns:

list of FieldWithShowWhenEmpty

Since:

9.9

updateShowWhenEmpty

@ExperimentalApi
ServiceResult updateShowWhenEmpty(FieldScreenLayoutItemId itemId,
                                                   FieldScreenOperationContext context,
                                                   boolean showWhenEmpty)

Update showWhenEmpty indicator of given FieldScreenLayoutItemId Can only be used within DC license or dev mode

Parameters:

itemId - id of field screen layout item

context - context in which current operation is being executed

showWhenEmpty - new value for indicator

Returns:

a ServiceResult indicating whether operation succeeded, or errors in case of failed validation

Since:

9.9