Package com.aquima.web.rest.v1.controller

Class CaseRestController

java.lang.Object

com.aquima.web.rest.v1.controller.RestControllerBase

com.aquima.web.rest.v1.controller.CaseRestController

@ConditionalOnBean(com.blueriq.component.api.workunit.IWorkUnitExecutor.class)
@ConditionalOnMissingBean(com.aquima.interactions.caseengine.client.CaseEngineClient.class)
@RestController
@RestApiContext
@RequestMapping(value="/cases",
                produces="application/json")
public class CaseRestController
extends RestControllerBase

Responsible for handling task specific requests

Since:

9.6

Author:

Marius Orsan

Field Summary

Fields

Modifier and Type	Field	Description
static String	MAPPING
static String	NAME

Fields inherited from class com.aquima.web.rest.v1.controller.RestControllerBase

DEFAULT_PAGE_NUMBER, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
CaseRestController(com.aquima.interactions.process.dao.IProcessCaseDao dao, com.blueriq.component.api.workunit.IWorkUnitExecutor executor)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributes(long caseId)	This method returns the attributes of a case
Case	getCase(long caseId, String attributes)	This method returns a case with the specified caseId
PagedCases	getCases(org.springframework.web.context.request.WebRequest request, Integer page, Integer pageSize, String sort, String attributes)	This method returns a list of cases

Methods inherited from class com.aquima.web.rest.v1.controller.RestControllerBase

getFilters, getUser

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

MAPPING

public static final String MAPPING

See Also:

Constant Field Values

Constructor Detail

CaseRestController

@Autowired
public CaseRestController(com.aquima.interactions.process.dao.IProcessCaseDao dao,
                          @Qualifier("TransactionalWorkUnitExecutor")
                          com.blueriq.component.api.workunit.IWorkUnitExecutor executor)

Method Detail

getCases

@RequestMapping(method=GET)
@ResponseStatus(OK)
@ResponseBody
public PagedCases getCases(org.springframework.web.context.request.WebRequest request,
                           @RequestParam(required=false)
                           Integer page,
                           @RequestParam(required=false)
                           Integer pageSize,
                           @RequestParam(required=false)
                           String sort,
                           @RequestParam(required=false)
                           String attributes)

This method returns a list of cases

Parameters:

request - the web request

page - The page number. Not required.

pageSize - The items per page. Not required.

sort - The properties to sort on. Comma separated. Not required.

attributes - The case attributes to include. Comma separated. Not required

Returns:

The list of paged cases

getCase

@RequestMapping(value="/{caseId}",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public Case getCase(@PathVariable("caseId")
                    long caseId,
                    @RequestParam(required=false)
                    String attributes)

This method returns a case with the specified caseId

Parameters:

caseId - The id of the case

attributes - The case attributes to include. Comma separated. Not required

Returns:

A case resource

getAttributes

@RequestMapping(value="/{caseId}/attributes",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> getAttributes(@PathVariable("caseId")
                                              long caseId)

This method returns the attributes of a case

Parameters:

caseId - The id of the case

Returns:

A Map with attributes values