Package com.atlassian.greenhopper.web.rapid.view.detailview

Class DetailViewFieldResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.view.detailview.DetailViewFieldResource

@Path("detailviewfield/{rapidViewId}")
@Consumes("application/json")
@Produces("application/json")
public class DetailViewFieldResource
extends AbstractResource

REST resource to facilitate configuration of Detail View Fields. Follows the pattern of RESTful table resources.

Since:

v6.0.3

Field Summary

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

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
DetailViewFieldResource(DetailViewFieldHelper detailViewFieldHelper, DetailViewFieldConfigurationService detailViewFieldConfigurationService, RapidViewService rapidViewService, EstimateStatisticService estimateStatisticService, I18nFactoryService i18nFactoryService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addDetailViewField(Long rapidViewId, com.atlassian.greenhopper.web.rapid.view.detailview.DetailViewFieldResource.AddDetailFieldRequest request)	Add a detail view field to the rapid view's configuration.
javax.ws.rs.core.Response	deleteDetailViewField(Long rapidViewId, Long detailViewFieldId)	Delete a field from a rapid view's detail view fields.
javax.ws.rs.core.Response	getAvailableDetailViewFields(Long rapidViewId)
javax.ws.rs.core.Response	getConfiguredDetailViewFields(Long rapidViewId)
javax.ws.rs.core.Response	moveDetailViewField(Long rapidViewId, Long detailViewFieldId, EntryMoveModel moveModel)	Modify the sequence of detail view fields for a rapid view.

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

DetailViewFieldResource

@Inject
public DetailViewFieldResource(DetailViewFieldHelper detailViewFieldHelper,
 DetailViewFieldConfigurationService detailViewFieldConfigurationService,
 RapidViewService rapidViewService,
 EstimateStatisticService estimateStatisticService,
 I18nFactoryService i18nFactoryService)

Method Details

getAvailableDetailViewFields

@GET
@Path("available")
public javax.ws.rs.core.Response getAvailableDetailViewFields(@PathParam("rapidViewId")
 Long rapidViewId)

getConfiguredDetailViewFields

@GET
@Path("configured")
public javax.ws.rs.core.Response getConfiguredDetailViewFields(@PathParam("rapidViewId")
 Long rapidViewId)

addDetailViewField

@POST
@Path("field")
public javax.ws.rs.core.Response addDetailViewField(@PathParam("rapidViewId")
 Long rapidViewId,
 com.atlassian.greenhopper.web.rapid.view.detailview.DetailViewFieldResource.AddDetailFieldRequest request)

Add a detail view field to the rapid view's configuration. The field is added as the first field in the list

deleteDetailViewField

@DELETE
@Path("field/{detailViewFieldId}")
public javax.ws.rs.core.Response deleteDetailViewField(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("detailViewFieldId")
 Long detailViewFieldId)

Delete a field from a rapid view's detail view fields.

moveDetailViewField

@POST
@Path("field/{detailViewFieldId}/move")
public javax.ws.rs.core.Response moveDetailViewField(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("detailViewFieldId")
 Long detailViewFieldId,
 EntryMoveModel moveModel)

Modify the sequence of detail view fields for a rapid view. NOTE: We only implement position=FIRST and after=... parameters. The alternative field value pairs:

position

An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'

after

An item to place this item after. The value should be the self link of another item