com.atlassian.jira.rest.v2.issue

Class ScreensResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.ScreensResource

public class ScreensResource
extends Object

Since:

v5.2

Constructor Summary

Constructors

Constructor and Description
ScreensResource(FieldScreenManager fieldScreenManager, FieldManager fieldManager, JiraAuthenticationContext jiraAuthenticationContext, PermissionManager permissionManager, CustomFieldService customFieldService, ProjectManager projectManager, FieldScreenService fieldScreenService, com.atlassian.event.api.EventPublisher eventPublisher, AccessDisablingHelper accessDisablingHelper)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addField(Long screenId, Long tabId, AddFieldBean field) Adds field to the given tab.
javax.ws.rs.core.Response	addFieldToDefaultScreen(String fieldId) Adds field or custom field to the default tab
javax.ws.rs.core.Response	addTab(Long screenId, ScreenableTabBean tab) Creates tab for given screen
javax.ws.rs.core.Response	deleteTab(Long screenId, Long tabId) Deletes tab to give screen
javax.ws.rs.core.Response	getAllFields(Long screenId, Long tabId, String projectKey) Gets all fields for a given tab
javax.ws.rs.core.Response	getAllScreens(String requestedWith, String startAt, String maxResults, String expand, String searchQuery) Gets available field screens
javax.ws.rs.core.Response	getAllTabs(Long screenId, String projectKey) Returns a list of all tabs for the given screen
javax.ws.rs.core.Response	getFieldsToAdd(Long screenId) Gets available fields for screen.
javax.ws.rs.core.Response	moveField(Long screenId, Long tabId, String id, MoveFieldBean moveField) Moves field on the given tab
javax.ws.rs.core.Response	moveTab(Long screenId, Long tabId, Integer pos) Moves tab position
javax.ws.rs.core.Response	removeField(Long screenId, Long tabId, String id) Removes field from given tab
javax.ws.rs.core.Response	renameTab(Long screenId, Long tabId, ScreenableTabBean tab) Renames tab on given screen

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreensResource

public ScreensResource(FieldScreenManager fieldScreenManager,
                       FieldManager fieldManager,
                       JiraAuthenticationContext jiraAuthenticationContext,
                       PermissionManager permissionManager,
                       CustomFieldService customFieldService,
                       ProjectManager projectManager,
                       FieldScreenService fieldScreenService,
                       com.atlassian.event.api.EventPublisher eventPublisher,
                       AccessDisablingHelper accessDisablingHelper)

Method Detail

getAllTabs

public javax.ws.rs.core.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

addTab

public javax.ws.rs.core.Response addTab(Long screenId,
                                        ScreenableTabBean tab)

Creates tab for given screen

Parameters:

screenId - id of screen

Returns:

a response containing newly created tab

renameTab

public javax.ws.rs.core.Response renameTab(Long screenId,
                                           Long tabId,
                                           ScreenableTabBean tab)

Renames tab on given screen

Parameters:

screenId - id of screen

Returns:

a response containing renamed tab

deleteTab

public javax.ws.rs.core.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

moveTab

public javax.ws.rs.core.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

getAllFields

public javax.ws.rs.core.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

getFieldsToAdd

public javax.ws.rs.core.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

removeField

public javax.ws.rs.core.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

moveField

public javax.ws.rs.core.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

addField

public javax.ws.rs.core.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

addFieldToDefaultScreen

public javax.ws.rs.core.Response addFieldToDefaultScreen(String fieldId)

Adds field or custom field to the default tab

Parameters:

fieldId - id of field / custom field

Returns:

no content

getAllScreens

public javax.ws.rs.core.Response getAllScreens(@HeaderParam(value="X-Requested-With")
                                               String requestedWith,
                                               String startAt,
                                               String maxResults,
                                               String expand,
                                               String searchQuery)

Gets available field screens

Parameters:

startAt - offset from which the response starts

maxResults - amount of field screens to return

Returns:

a response containing either list of field screens, or paginated list of field screens