Class HvlBpmnTaskRestController
java.lang.Object
tr.com.havelsan.javarch.bpmn.engine.starter.module.task.controller.HvlBpmnTaskRestController
- All Implemented Interfaces:
HvlBpmnTaskOperationalRestService
,HvlBpmnTaskRestService
@RestController
@RequestMapping("${hvl.bpmn.service.task.controller-path:/task}")
@HvlActuatorService(name="hvlBpmnTaskRestService",
groupName="hvlBpmnTask")
public class HvlBpmnTaskRestController
extends Object
implements HvlBpmnTaskRestService, HvlBpmnTaskOperationalRestService
* A restful service which provides specific methods for bpmn engine task.
-
Constructor Summary
ConstructorDescriptionHvlBpmnTaskRestController
(HvlBpmnTaskService taskService, HvlBpmnTaskQueryGenerator taskQueryGenerator, HvlBpmnTaskMapper taskMapper, HvlBpmnProcessInstanceMapper processInstanceMapper) Instantiates a new HvlBpmnTaskRestController. -
Method Summary
Modifier and TypeMethodDescriptiontr.com.havelsan.javarch.service.data.HvlResponse<Void>
Claims the task.tr.com.havelsan.javarch.service.data.HvlResponse<Void>
complete
(@NotNull @Valid HvlBpmnCompleteTaskModel completeTaskModel) Completes the task.tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnTaskModel>
Gets the task by id.tr.com.havelsan.javarch.service.data.HvlResponse<Object>
getVariable
(@NotBlank String taskId, @NotBlank String variableName) Gets the task variable.getVariables
(@NotBlank String taskId) Gets the task variables.tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnTaskModel>>
queryList
(@NotNull HvlBpmnTaskQueryModel bpmnTaskQueryModel) Returns a list of task matching the query criteria.tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnTaskModel>>
queryPage
(@NotNull HvlBpmnTaskQueryModel bpmnTaskQueryModel) Returns a page of task matching the query criteria.tr.com.havelsan.javarch.service.data.HvlResponse<Void>
Unclaims the task.
-
Constructor Details
-
HvlBpmnTaskRestController
public HvlBpmnTaskRestController(HvlBpmnTaskService taskService, HvlBpmnTaskQueryGenerator taskQueryGenerator, HvlBpmnTaskMapper taskMapper, HvlBpmnProcessInstanceMapper processInstanceMapper) Instantiates a new HvlBpmnTaskRestController.- Parameters:
taskService
- the task servicetaskQueryGenerator
- the task query generatortaskMapper
- the task mapperprocessInstanceMapper
- the process instance mapper
-
-
Method Details
-
claim
public tr.com.havelsan.javarch.service.data.HvlResponse<Void> claim(@NotBlank @PathVariable("id") @NotBlank String taskId, @NotBlank @PathVariable("assignee") @NotBlank String assignee) Claims the task.- Specified by:
claim
in interfaceHvlBpmnTaskOperationalRestService
- Parameters:
taskId
- the task idassignee
- the assignee- Returns:
- the hvl response
-
unclaim
public tr.com.havelsan.javarch.service.data.HvlResponse<Void> unclaim(@NotBlank @PathVariable("id") @NotBlank String id) Unclaims the task.- Specified by:
unclaim
in interfaceHvlBpmnTaskOperationalRestService
- Parameters:
id
- the id- Returns:
- the hvl response
-
complete
public tr.com.havelsan.javarch.service.data.HvlResponse<Void> complete(@NotNull @Valid @RequestBody @NotNull @Valid HvlBpmnCompleteTaskModel completeTaskModel) Completes the task.- Specified by:
complete
in interfaceHvlBpmnTaskOperationalRestService
- Parameters:
completeTaskModel
- the complete task model- Returns:
- the hvl response
-
getById
public tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnTaskModel> getById(@NotBlank @PathVariable("id") @NotBlank String id) Gets the task by id.- Specified by:
getById
in interfaceHvlBpmnTaskRestService
- Parameters:
id
- the id- Returns:
- the by id
-
queryList
public tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnTaskModel>> queryList(@NotNull @RequestBody @NotNull HvlBpmnTaskQueryModel bpmnTaskQueryModel) Returns a list of task matching the query criteria.- Specified by:
queryList
in interfaceHvlBpmnTaskRestService
- Parameters:
bpmnTaskQueryModel
- the process instance query model- Returns:
- the hvl response
-
queryPage
public tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnTaskModel>> queryPage(@NotNull @RequestBody @NotNull HvlBpmnTaskQueryModel bpmnTaskQueryModel) Returns a page of task matching the query criteria.- Specified by:
queryPage
in interfaceHvlBpmnTaskRestService
- Parameters:
bpmnTaskQueryModel
- the process definition query model- Returns:
- the hvl response
-
getVariable
public tr.com.havelsan.javarch.service.data.HvlResponse<Object> getVariable(@NotBlank @PathVariable("taskId") @NotBlank String taskId, @NotBlank @PathVariable("variableName") @NotBlank String variableName) Gets the task variable.- Specified by:
getVariable
in interfaceHvlBpmnTaskRestService
- Parameters:
taskId
- the task idvariableName
- the variable name- Returns:
- the variable
-
getVariables
public tr.com.havelsan.javarch.service.data.HvlResponse<Map<String,Object>> getVariables(@NotBlank @PathVariable("taskId") @NotBlank String taskId) Gets the task variables.- Specified by:
getVariables
in interfaceHvlBpmnTaskRestService
- Parameters:
taskId
- the task id- Returns:
- the variables
-