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

Class CaseEventsRestController

java.lang.Object

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

com.aquima.web.rest.v1.controller.CaseEventsRestController

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

Responsible for handling case events specific requests.

Since:

9.6

Author:

Voicu Moldovan

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
CaseEventsRestController(com.aquima.interactions.process.dao.IProcessCaseDao dao, com.aquima.interactions.portal.IPortalEngine portalEngine, com.blueriq.component.api.workunit.IWorkUnitExecutor executor)

Method Summary

Modifier and Type	Method	Description
CaseEvent	getCaseEvent(Long eventId)	This method returns a case event based on the event id.
PagedCaseEvents	getCaseEvents(org.springframework.web.context.request.WebRequest request, Integer page, Integer pageSize, String sort)	Searches for a list of case events that match a certain criteria.
org.springframework.http.ResponseEntity<Void>	replayCaseEvent(Long eventId, Long caseId)

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

CaseEventsRestController

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

Method Detail

getCaseEvents

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

Searches for a list of case events that match a certain criteria.

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.

Returns:

The list of case events.

getCaseEvent

@RequestMapping(value="/{eventId}",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public CaseEvent getCaseEvent(@PathVariable("eventId")
                              Long eventId)

This method returns a case event based on the event id.

Parameters:

eventId - The id of the case event. Required.

Returns:

The case event resource.

replayCaseEvent

@RequestMapping(value="/{eventId}",
                method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public org.springframework.http.ResponseEntity<Void> replayCaseEvent(@PathVariable("eventId")
                                                                     Long eventId,
                                                                     @RequestParam(required=false)
                                                                     Long caseId)