Package com.atlassian.greenhopper.web.rapid.issue

Class IssueResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.issue.IssueResource

@Path("xboard/issue")
@Produces("application/json")
public class IssueResource
extends AbstractResource

Provides issue related rest resources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IssueResource.MatchesBoardResponse
static class	IssueResource.SetVersionRequest

Field Summary

Fields inherited from class com.atlassian.greenhopper.web.AbstractResource

authenticationContext, log

Constructor Summary

Constructors

Constructor

Description

IssueResource(IssueEntryFactory issueEntryFactory, TransitionEntryFactory transitionEntryFactory, IssueHelper issueHelper, RapidViewService rapidViewService, PoolService poolService, EstimateStatisticService estimateStatisticService, SprintIssueService sprintIssueService, TrackingStatisticService trackingStatisticService, VersionService versionService, com.atlassian.jira.bc.project.version.VersionService jiraVersionService, com.atlassian.jira.bc.issue.IssueService issueService, RapidViewQueryService rapidViewQueryService, SearchService searchService, TabModelFactoryFactory tabModelFactoryFactory, DetailViewFieldService detailViewFieldService, ColumnService columnService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	areSubtasksResolved(Long issueId, Long rapidViewId)
jakarta.ws.rs.core.Response	clearFixVersion(IssueResource.SetVersionRequest setVersionRequest)
jakarta.ws.rs.core.Response	doIssuesMatchBoard(Set<String> issueIdsOrKeys, Long rapidViewId)
jakarta.ws.rs.core.Response	getEditData(jakarta.ws.rs.core.Request request, String issueIdOrKey, Long rapidViewId)	Get the edit values for for a single issue.
jakarta.ws.rs.core.Response	getPageData(jakarta.ws.rs.core.Request request, String issueIdOrKey, Long rapidViewId, boolean loadSubtasks)	Get the details for a single issue.
jakarta.ws.rs.core.Response	getPageData(jakarta.ws.rs.core.Request request, String issueIdOrKey, Long rapidViewId, boolean loadSubtasks, String tabId)
jakarta.ws.rs.core.Response	getTransitions(Long issueId)	Get the list of possible transitions for the given issue.
jakarta.ws.rs.core.Response	setFixVersion(IssueResource.SetVersionRequest setVersionRequest)	Set a fix version for each provided issues.
jakarta.ws.rs.core.Response	updateField(com.atlassian.greenhopper.web.rapid.issue.IssueResource.UpdateFieldRequest updateFieldRequest)	Stores a single field value

Methods inherited from class com.atlassian.greenhopper.web.AbstractResource

check, checkResult, createNoContentResponse, createOkResponse, createOkResponse, getUser, isGadgetRequest, nullSafe, response, responseWithoutAccessCheck

Methods inherited from class java.lang.Object

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

Constructor Details

IssueResource

@Inject
public IssueResource(IssueEntryFactory issueEntryFactory,
 TransitionEntryFactory transitionEntryFactory,
 IssueHelper issueHelper,
 RapidViewService rapidViewService,
 PoolService poolService,
 EstimateStatisticService estimateStatisticService,
 SprintIssueService sprintIssueService,
 TrackingStatisticService trackingStatisticService,
 VersionService versionService,
 com.atlassian.jira.bc.project.version.VersionService jiraVersionService,
 com.atlassian.jira.bc.issue.IssueService issueService,
 RapidViewQueryService rapidViewQueryService,
 SearchService searchService,
 TabModelFactoryFactory tabModelFactoryFactory,
 DetailViewFieldService detailViewFieldService,
 ColumnService columnService)

Method Details

getPageData

@Path("/details")
@GET
public jakarta.ws.rs.core.Response getPageData(@Context
 jakarta.ws.rs.core.Request request,
 @QueryParam("issueIdOrKey")
 String issueIdOrKey,
 @QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("loadSubtasks")
 boolean loadSubtasks)

Get the details for a single issue.

Parameters:

issueIdOrKey - the issue id or key to query

getPageData

@Path("/details/{tabId}")
@GET
public jakarta.ws.rs.core.Response getPageData(@Context
 jakarta.ws.rs.core.Request request,
 @QueryParam("issueIdOrKey")
 String issueIdOrKey,
 @QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("loadSubtasks")
 boolean loadSubtasks,
 @PathParam("tabId")
 String tabId)

areSubtasksResolved

@Path("/subtasksInFinalColumn")
@GET
public jakarta.ws.rs.core.Response areSubtasksResolved(@QueryParam("issueId")
 Long issueId,
 @QueryParam("rapidViewId")
 Long rapidViewId)

getTransitions

@Path("/transitions")
@GET
public jakarta.ws.rs.core.Response getTransitions(@QueryParam("issueId")
 Long issueId)

Get the list of possible transitions for the given issue.

Parameters:

issueId - the issue id to query

getEditData

@Path("/edit-data")
@GET
public jakarta.ws.rs.core.Response getEditData(@Context
 jakarta.ws.rs.core.Request request,
 @QueryParam("issueIdOrKey")
 String issueIdOrKey,
 @QueryParam("rapidViewId")
 Long rapidViewId)

Get the edit values for for a single issue.

Parameters:

issueIdOrKey - the issue id or key to query

updateField

@Path("/update-field")
@PUT
public jakarta.ws.rs.core.Response updateField(com.atlassian.greenhopper.web.rapid.issue.IssueResource.UpdateFieldRequest updateFieldRequest)

Stores a single field value

setFixVersion

@PUT
@Path("fixversion/set")
public jakarta.ws.rs.core.Response setFixVersion(IssueResource.SetVersionRequest setVersionRequest)

Set a fix version for each provided issues.

We can't use the JIRA REST API because we need to be able to edit the fix version field regardless of the edit screen configuration.

clearFixVersion

@PUT
@Path("fixversion/clear")
public jakarta.ws.rs.core.Response clearFixVersion(IssueResource.SetVersionRequest setVersionRequest)

doIssuesMatchBoard

@GET
@Path("matchesBoard")
public jakarta.ws.rs.core.Response doIssuesMatchBoard(@QueryParam("issueIdsOrKeys")
 Set<String> issueIdsOrKeys,
 @QueryParam("rapidViewId")
 Long rapidViewId)