public class

ScreensResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.issue.ScreensResource

Summary

Public Constructors
ScreensResource(FieldScreenManager fieldScreenManager, FieldManager fieldManager, JiraAuthenticationContext jiraAuthenticationContext, PermissionManager permissionManager, I18nHelper i18n, CustomFieldService customFieldService, ProjectManager projectManager, ProjectFieldScreenHelper projectFieldScreenHelper)
Public Methods
Response addField(Long screenId, Long tabId, AddFieldBean field)
Adds field to the given tab
Response addFieldToDefaultScreen(String fieldId)
Adds field or custom field to the default tab
Response addTab(Long screenId, ScreenableTabBean tab)
Creates tab for given screen
Response deleteTab(Long screenId, Long tabId)
Deletes tab to give screen
Response getAllFields(Long screenId, Long tabId, String projectKey)
Gets all fields for a given tab
Response getAllTabs(Long screenId, String projectKey)
Returns a list of all tabs for the given screen
Response getFieldsToAdd(Long screenId)
Gets available fields for screen.
Response moveField(Long screenId, Long tabId, String id, MoveFieldBean moveField)
Moves field on the given tab
Response moveTab(Long screenId, Long tabId, Integer pos)
Moves tab position
Response removeField(Long screenId, Long tabId, String id)
Removes field from given tab
Response renameTab(Long screenId, Long tabId, ScreenableTabBean tab)
Renames tab on given screen
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ScreensResource (FieldScreenManager fieldScreenManager, FieldManager fieldManager, JiraAuthenticationContext jiraAuthenticationContext, PermissionManager permissionManager, I18nHelper i18n, CustomFieldService customFieldService, ProjectManager projectManager, ProjectFieldScreenHelper projectFieldScreenHelper)

Public Methods

public Response addField (Long screenId, Long tabId, AddFieldBean field)

Adds field to the given tab

Parameters
screenId id of screen
tabId id of tab
Returns
  • no content

public Response addFieldToDefaultScreen (String fieldId)

Adds field or custom field to the default tab

Parameters
fieldId id of field / custom field
Returns
  • no content

public Response addTab (Long screenId, ScreenableTabBean tab)

Creates tab for given screen

Parameters
screenId id of screen
Returns
  • a response containing newly created tab

public Response deleteTab (Long screenId, Long tabId)

Deletes tab to give screen

Parameters
screenId id of screen
tabId id of tab
Returns
  • A response containing no content

public Response getAllFields (Long screenId, Long tabId, String projectKey)

Gets all fields for a given tab

Parameters
screenId id of screen
tabId id of tab
projectKey the key of the project; this parameter is optional
Returns
  • a response containing all fields for given tab

public Response getAllTabs (Long screenId, String projectKey)

Returns a list of all tabs for the given screen

Parameters
screenId id of screen
projectKey the key of the project; this parameter is optional
Returns
  • a response containing all tabs for screen

public Response getFieldsToAdd (Long screenId)

Gets available fields for screen. i.e ones that haven't already been added.

Parameters
screenId id of screen
Returns
  • a response containing available fields

public Response moveField (Long screenId, Long tabId, String id, MoveFieldBean moveField)

Moves field on the given tab

Parameters
screenId id of screen
tabId id of tab
Returns
  • no content

public Response moveTab (Long screenId, Long tabId, Integer pos)

Moves tab position

Parameters
screenId id of screen
tabId id of tab
pos position of tab
Returns
  • A response containing no content

public Response removeField (Long screenId, Long tabId, String id)

Removes field from given tab

Parameters
screenId id of screen
tabId id of tab
Returns
  • no content

public Response renameTab (Long screenId, Long tabId, ScreenableTabBean tab)

Renames tab on given screen

Parameters
screenId id of screen
Returns
  • a response containing renamed tab