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

Class EpicResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.issue.issuelink.EpicResource

@Path("epics")
@Consumes("application/json")
@Produces("application/json")
public class EpicResource
extends AbstractResource

Resource for changing epic-issue links.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EpicResource.AddToEpicRequest
static class	EpicResource.EpicNameListModel
static class	EpicResource.EpicNameModel
static class	EpicResource.FindEpicNamesResponse
static class	EpicResource.LinkPageToEpicModel
static class	EpicResource.RemoveFromEpicRequest

Field Summary

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

authenticationContext, log

Constructor Summary

Constructors

Constructor

Description

EpicResource(EpicService epicService, EpicPickerService epicPickerService, IssueHelper issueHelper, IssueTypeService issueTypeService, EpicLabelProviderImpl epicLabelProvider, com.atlassian.jira.issue.fields.rest.json.beans.JiraBaseUrls jiraBaseUrls, com.atlassian.applinks.host.spi.InternalHostApplication internalHostApplication, PermissionService permissionService, EpicLinkedPagesModelFactory epicLinkedPagesModelFactory)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	associateIssuesToEpic(String epicKey, EpicResource.AddToEpicRequest addToEpicRequest)
jakarta.ws.rs.core.Response	disassociateIssuesFromEpic(EpicResource.RemoveFromEpicRequest removeFromEpicRequest)	Remove the epic for the list of passed issues
jakarta.ws.rs.core.Response	getPages(String epicKey)	Returns all the confluence pages linked to the given epic
jakarta.ws.rs.core.Response	linkPage(String epicKey, EpicResource.LinkPageToEpicModel model)	Links a confluence page to an epic
jakarta.ws.rs.core.Response	listEpics(String searchQuery, int maxResults, String projectKeys, boolean hideDone, String query, boolean filterEpicByGivenProjects)

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

EpicResource

@Inject
public EpicResource(EpicService epicService,
 EpicPickerService epicPickerService,
 IssueHelper issueHelper,
 IssueTypeService issueTypeService,
 EpicLabelProviderImpl epicLabelProvider,
 com.atlassian.jira.issue.fields.rest.json.beans.JiraBaseUrls jiraBaseUrls,
 com.atlassian.applinks.host.spi.InternalHostApplication internalHostApplication,
 PermissionService permissionService,
 EpicLinkedPagesModelFactory epicLinkedPagesModelFactory)

Method Details

associateIssuesToEpic

@PUT
@Path("{epicKey}/add")
public jakarta.ws.rs.core.Response associateIssuesToEpic(@PathParam("epicKey")
 String epicKey,
 EpicResource.AddToEpicRequest addToEpicRequest)

disassociateIssuesFromEpic

@PUT
@Path("remove")
public jakarta.ws.rs.core.Response disassociateIssuesFromEpic(EpicResource.RemoveFromEpicRequest removeFromEpicRequest)

Remove the epic for the list of passed issues

getPages

@GET
@Path("{epicKey}/pages")
public jakarta.ws.rs.core.Response getPages(@PathParam("epicKey")
 String epicKey)

Returns all the confluence pages linked to the given epic

Parameters:

epicKey -

Returns:

linkPage

@POST
@Path("/{epicKey}/pages")
public jakarta.ws.rs.core.Response linkPage(@PathParam("epicKey")
 String epicKey,
 EpicResource.LinkPageToEpicModel model)

Links a confluence page to an epic

Parameters:

epicKey -

model -

Returns:

listEpics

@GET
public jakarta.ws.rs.core.Response listEpics(@QueryParam("searchQuery")
 String searchQuery,
 @QueryParam("maxResults")
 int maxResults,
 @QueryParam("projectKey")
 String projectKeys,
 @QueryParam("hideDone")
 boolean hideDone,
 @QueryParam("query")
 String query,
 @QueryParam("filterEpicsByGivenProjects")
 boolean filterEpicByGivenProjects)