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

Class DefaultFieldScreenService

java.lang.Object

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

All Implemented Interfaces:

FieldScreenService

public class DefaultFieldScreenService
extends Object
implements FieldScreenService

Since:

v5.2

Constructor Summary

Constructors

Constructor and Description

DefaultFieldScreenService(I18nHelper.BeanFactory i18nFactory, FieldScreenManager fieldScreenManager, GlobalPermissionManager globalPermissionManager, ProjectFieldScreenHelper projectFieldScreenHelper, FieldManager fieldManager, com.atlassian.event.api.EventPublisher eventPublisher, FieldScreenSchemeManager fieldScreenSchemeManager, WorkflowManager workflowManager, DcLicenseOrDevModeChecker dcLicenseOrDevModeChecker)

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Field>	addFieldToScreen(FieldScreenTabId tabId, String fieldId, FieldScreenOperationContext context) Adds a new field to the given tab
ServiceOutcome<FieldScreenTab>	addTab(FieldScreenId screenId, String tabName, FieldScreenOperationContext context) Creates and adds new tab for screen
ServiceOutcome<FieldScreen>	copy(FieldScreen screenToCopy, 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 screenId, FieldScreenOperationContext context) Returns a list of all tabs for the given screen
ServiceOutcome<List<OrderableField>>	getAvailableFieldsForScreen(FieldScreenId screenId, FieldScreenOperationContext context) Gets all fields, that can be added to given screen.
ServiceOutcome<List<Field>>	getFieldsOnTab(FieldScreenTabId tabId, 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 id, FieldScreenOperationContext context) Gets information whether field screen can be safely deleted
ServiceResult	moveField(FieldScreenLayoutItemId fieldToMoveId, MoveFieldInfo moveInfo, FieldScreenOperationContext context) Moves field along the tab, according to instructed details
ServiceOutcome<FieldScreenTab>	moveTab(FieldScreenTabId tabId, 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 tabId, FieldScreenOperationContext context) Removes tab from screen
ServiceOutcome<FieldScreenTab>	renameTab(FieldScreenTabId tabId, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFieldScreenService

public DefaultFieldScreenService(I18nHelper.BeanFactory i18nFactory,
                                 FieldScreenManager fieldScreenManager,
                                 GlobalPermissionManager globalPermissionManager,
                                 ProjectFieldScreenHelper projectFieldScreenHelper,
                                 FieldManager fieldManager,
                                 com.atlassian.event.api.EventPublisher eventPublisher,
                                 FieldScreenSchemeManager fieldScreenSchemeManager,
                                 WorkflowManager workflowManager,
                                 DcLicenseOrDevModeChecker dcLicenseOrDevModeChecker)

Method Detail

copy

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

Description copied from interface: FieldScreenService

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

Specified by:

copy in interface FieldScreenService

Parameters:

screenToCopy - screen to copy

copyName - name for the copied screen

copyDescription - description for the copied screen

loggedInUser - user performing the copy

Returns:

copy result

getAllTabs

public ServiceOutcome<List<FieldScreenTab>> getAllTabs(FieldScreenId screenId,
                                                       FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Returns a list of all tabs for the given screen

Specified by:

getAllTabs in interface FieldScreenService

Parameters:

screenId - 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

addTab

public ServiceOutcome<FieldScreenTab> addTab(FieldScreenId screenId,
                                             String tabName,
                                             FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Creates and adds new tab for screen

Specified by:

addTab in interface FieldScreenService

Parameters:

screenId - 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

renameTab

public ServiceOutcome<FieldScreenTab> renameTab(FieldScreenTabId tabId,
                                                String newName,
                                                FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Renames already existing tab on given screen

Specified by:

renameTab in interface FieldScreenService

Parameters:

tabId - 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

removeTab

public ServiceResult removeTab(FieldScreenTabId tabId,
                               FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Removes tab from screen

Specified by:

removeTab in interface FieldScreenService

Parameters:

tabId - 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

moveTab

public ServiceOutcome<FieldScreenTab> moveTab(FieldScreenTabId tabId,
                                              Integer position,
                                              FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Moves tab position on given screen

Specified by:

moveTab in interface FieldScreenService

Parameters:

tabId - 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

getFieldsOnTab

public ServiceOutcome<List<Field>> getFieldsOnTab(FieldScreenTabId tabId,
                                                  FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Gets all fields on given tab

Specified by:

getFieldsOnTab in interface FieldScreenService

Parameters:

tabId - 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

getAvailableFieldsForScreen

public ServiceOutcome<List<OrderableField>> getAvailableFieldsForScreen(FieldScreenId screenId,
                                                                        FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

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

Specified by:

getAvailableFieldsForScreen in interface FieldScreenService

Parameters:

screenId - 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

removeField

public ServiceResult removeField(FieldScreenLayoutItemId item,
                                 FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Removes a field from the tab and effectively from the screen

Specified by:

removeField in interface FieldScreenService

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

moveField

public ServiceResult moveField(FieldScreenLayoutItemId fieldToMoveId,
                               MoveFieldInfo moveInfo,
                               FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Moves field along the tab, according to instructed details

Specified by:

moveField in interface FieldScreenService

Parameters:

fieldToMoveId - 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

addFieldToScreen

public ServiceOutcome<Field> addFieldToScreen(FieldScreenTabId tabId,
                                              String fieldId,
                                              FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Adds a new field to the given tab

Specified by:

addFieldToScreen in interface FieldScreenService

Parameters:

tabId - 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

getIsFieldScreenDeletable

public ServiceOutcome<Boolean> getIsFieldScreenDeletable(FieldScreenId id,
                                                         FieldScreenOperationContext context)

Description copied from interface: FieldScreenService

Gets information whether field screen can be safely deleted

Specified by:

getIsFieldScreenDeletable in interface FieldScreenService

Parameters:

id - 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

updateShowWhenEmpty

public ServiceResult updateShowWhenEmpty(FieldScreenLayoutItemId itemId,
                                         FieldScreenOperationContext context,
                                         boolean showWhenEmpty)

Description copied from interface: FieldScreenService

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

Specified by:

updateShowWhenEmpty in interface FieldScreenService

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

getFieldsWithShowWhenEmpty

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

Description copied from interface: FieldScreenService

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

Specified by:

getFieldsWithShowWhenEmpty in interface FieldScreenService

Parameters:

tabId - id of a tab

context - context in which current operation is being executed

Returns:

list of FieldWithShowWhenEmpty