Package org.camunda.bpm.engine.rest.impl.history

Class HistoricProcessInstanceRestServiceImpl

java.lang.Object

org.camunda.bpm.engine.rest.impl.history.HistoricProcessInstanceRestServiceImpl

All Implemented Interfaces:

HistoricProcessInstanceRestService

public class HistoricProcessInstanceRestServiceImpl
extends Object
implements HistoricProcessInstanceRestService

Field Summary

Fields

Modifier and Type	Field	Description
static final jakarta.ws.rs.core.MediaType	APPLICATION_CSV_TYPE
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected ProcessEngine	processEngine
static final jakarta.ws.rs.core.MediaType	TEXT_CSV_TYPE
static final List<jakarta.ws.rs.core.Variant>	VARIANTS

Fields inherited from interface org.camunda.bpm.engine.rest.history.HistoricProcessInstanceRestService

PATH

Constructor Summary

Constructors

Constructor	Description
HistoricProcessInstanceRestServiceImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper, ProcessEngine processEngine)

Method Summary

Modifier and Type	Method	Description
BatchDto	deleteAsync(DeleteHistoricProcessInstancesDto dto)
jakarta.ws.rs.core.Response	deleteHistoricVariableInstancesByProcessInstanceId(String processInstanceId)
HistoricProcessInstanceResource	getHistoricProcessInstance(String processInstanceId)
List<HistoricProcessInstanceDto>	getHistoricProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the HistoricProcessInstanceQuery interface as a REST service.
CountResultDto	getHistoricProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	getHistoricProcessInstancesReport(jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.Request request)
protected String	getReportResultAsCsv(jakarta.ws.rs.core.UriInfo uriInfo)
protected List<ReportResultDto>	getReportResultAsJson(jakarta.ws.rs.core.UriInfo uriInfo)
protected List<ReportResult>	queryHistoricProcessInstanceReport(jakarta.ws.rs.core.UriInfo uriInfo)
List<HistoricProcessInstanceDto>	queryHistoricProcessInstances(HistoricProcessInstanceQueryDto queryDto, Integer firstResult, Integer maxResults)
CountResultDto	queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto queryDto)
BatchDto	setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto dto)

Methods inherited from class java.lang.Object

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

Field Details

APPLICATION_CSV_TYPE

public static final jakarta.ws.rs.core.MediaType APPLICATION_CSV_TYPE

TEXT_CSV_TYPE

public static final jakarta.ws.rs.core.MediaType TEXT_CSV_TYPE

VARIANTS

public static final List<jakarta.ws.rs.core.Variant> VARIANTS

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

processEngine

protected ProcessEngine processEngine

Constructor Details

HistoricProcessInstanceRestServiceImpl

public HistoricProcessInstanceRestServiceImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 ProcessEngine processEngine)

Method Details

getHistoricProcessInstance

public HistoricProcessInstanceResource getHistoricProcessInstance(String processInstanceId)

Specified by:

getHistoricProcessInstance in interface HistoricProcessInstanceRestService

getHistoricProcessInstances

public List<HistoricProcessInstanceDto> getHistoricProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: HistoricProcessInstanceRestService

Exposes the HistoricProcessInstanceQuery interface as a REST service.

Specified by:

getHistoricProcessInstances in interface HistoricProcessInstanceRestService

Returns:

queryHistoricProcessInstances

public List<HistoricProcessInstanceDto> queryHistoricProcessInstances(HistoricProcessInstanceQueryDto queryDto,
 Integer firstResult,
 Integer maxResults)

Specified by:

queryHistoricProcessInstances in interface HistoricProcessInstanceRestService

Returns:

getHistoricProcessInstancesCount

public CountResultDto getHistoricProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)

Specified by:

getHistoricProcessInstancesCount in interface HistoricProcessInstanceRestService

queryHistoricProcessInstancesCount

public CountResultDto queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto queryDto)

Specified by:

queryHistoricProcessInstancesCount in interface HistoricProcessInstanceRestService

queryHistoricProcessInstanceReport

protected List<ReportResult> queryHistoricProcessInstanceReport(jakarta.ws.rs.core.UriInfo uriInfo)

getHistoricProcessInstancesReport

public jakarta.ws.rs.core.Response getHistoricProcessInstancesReport(jakarta.ws.rs.core.UriInfo uriInfo,
 jakarta.ws.rs.core.Request request)

Specified by:

getHistoricProcessInstancesReport in interface HistoricProcessInstanceRestService

deleteAsync

public BatchDto deleteAsync(DeleteHistoricProcessInstancesDto dto)

Specified by:

deleteAsync in interface HistoricProcessInstanceRestService

setRemovalTimeAsync

public BatchDto setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto dto)

Specified by:

setRemovalTimeAsync in interface HistoricProcessInstanceRestService

getReportResultAsJson

protected List<ReportResultDto> getReportResultAsJson(jakarta.ws.rs.core.UriInfo uriInfo)

getReportResultAsCsv

protected String getReportResultAsCsv(jakarta.ws.rs.core.UriInfo uriInfo)

deleteHistoricVariableInstancesByProcessInstanceId

public jakarta.ws.rs.core.Response deleteHistoricVariableInstancesByProcessInstanceId(String processInstanceId)

Specified by:

deleteHistoricVariableInstancesByProcessInstanceId in interface HistoricProcessInstanceRestService