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

Class CardLayoutResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.view.cardlayout.CardLayoutResource

@Path("cardlayout/{rapidViewId}/{mode}")
@Consumes("application/json")
@Produces("application/json")
public class CardLayoutResource
extends AbstractResource

REST resource to facilitate card layout configuration. Follows the pattern of RESTful table resources.

Since:

v6.5

Field Summary

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

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
CardLayoutResource(CardLayoutHelper cardLayoutHelper, CardLayoutFieldConfigurationService cardLayoutFieldConfigurationService, RapidViewService rapidViewService, I18nFactoryService i18nFactoryService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addCardLayoutField(Long rapidViewId, String modeName, com.atlassian.greenhopper.web.rapid.view.cardlayout.CardLayoutResource.AddCardLayoutFieldRequest request)	Add a field to the rapid view's card layout configuration.
jakarta.ws.rs.core.Response	deleteCardLayoutField(Long rapidViewId, String modeName, Long cardLayoutFieldId)	Delete a field from a rapid view's card layout configuration.
jakarta.ws.rs.core.Response	getAvailableCardLayoutFields(Long rapidViewId, String modeName)	Get a set of fields that can be added to a card layout configuration for a given board and mode.
jakarta.ws.rs.core.Response	getCardLayoutFields(Long rapidViewId, String modeName)	Get all fields that have been configured for this layout
jakarta.ws.rs.core.Response	moveCardLayoutField(Long rapidViewId, String modeName, Long cardLayoutFieldId, EntryMoveModel moveModel)	Modify the sequence of card layout 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

CardLayoutResource

@Inject
public CardLayoutResource(CardLayoutHelper cardLayoutHelper,
 CardLayoutFieldConfigurationService cardLayoutFieldConfigurationService,
 RapidViewService rapidViewService,
 I18nFactoryService i18nFactoryService)

Method Details

getAvailableCardLayoutFields

@GET
@Path("available")
public jakarta.ws.rs.core.Response getAvailableCardLayoutFields(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("mode")
 String modeName)

Get a set of fields that can be added to a card layout configuration for a given board and mode.

addCardLayoutField

@POST
@Path("field")
public jakarta.ws.rs.core.Response addCardLayoutField(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("mode")
 String modeName,
 com.atlassian.greenhopper.web.rapid.view.cardlayout.CardLayoutResource.AddCardLayoutFieldRequest request)

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

getCardLayoutFields

@GET
@Path("field")
public jakarta.ws.rs.core.Response getCardLayoutFields(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("mode")
 String modeName)

Get all fields that have been configured for this layout

deleteCardLayoutField

@DELETE
@Path("field/{cardLayoutFieldId}")
public jakarta.ws.rs.core.Response deleteCardLayoutField(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("mode")
 String modeName,
 @PathParam("cardLayoutFieldId")
 Long cardLayoutFieldId)

Delete a field from a rapid view's card layout configuration.

moveCardLayoutField

@POST
@Path("field/{cardLayoutFieldId}/move")
public jakarta.ws.rs.core.Response moveCardLayoutField(@PathParam("rapidViewId")
 Long rapidViewId,
 @PathParam("mode")
 String modeName,
 @PathParam("cardLayoutFieldId")
 Long cardLayoutFieldId,
 EntryMoveModel moveModel)

Modify the sequence of card layout 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'

after

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