org.camunda.bpm.engine.rest.dto.runtime

Class ProcessInstanceQueryDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

org.camunda.bpm.engine.rest.dto.AbstractQueryDto<ProcessInstanceQuery>

org.camunda.bpm.engine.rest.dto.runtime.ProcessInstanceQueryDto

public class ProcessInstanceQueryDto
extends AbstractQueryDto<ProcessInstanceQuery>

Field Summary

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

expressions, SORT_ORDER_ASC_VALUE, SORT_ORDER_DESC_VALUE, sortBy, sortings, sortOrder, VALID_SORT_ORDER_VALUES

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

objectMapper

Constructor Summary

Constructors

Constructor and Description
ProcessInstanceQueryDto()
ProcessInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method and Description
protected void	applyFilters(ProcessInstanceQuery query)
protected void	applySortBy(ProcessInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected ProcessInstanceQuery	createNewQuery(ProcessEngine engine)
List<String>	getActivityIds()
String	getBusinessKey()
String	getBusinessKeyLike()
String	getCaseInstanceId()
String	getDeploymentId()
String	getIncidentId()
String	getIncidentMessage()
String	getIncidentMessageLike()
String	getIncidentType()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
Set<String>	getProcessInstanceIds()
String	getSubCaseInstance()
String	getSubProcessInstance()
String	getSuperCaseInstance()
String	getSuperProcessInstance()
List<String>	getTenantIdIn()
List<VariableQueryParameterDto>	getVariables()
Boolean	isActive()
Boolean	isLeafProcessInstances()
Boolean	isProcessDefinitionWithoutTenantId()
Boolean	isRootProcessInstances()
Boolean	isSuspended()
protected boolean	isValidSortByValue(String value)
Boolean	isWithIncident()
Boolean	isWithoutTenantId()
void	setActive(Boolean active)
void	setActivityIdIn(List<String> activityIds)
void	setBusinessKey(String businessKey)
void	setBusinessKeyLike(String businessKeyLike)
void	setCaseInstanceId(String caseInstanceId)
void	setDeploymentId(String deploymentId)
void	setIncidentId(String incidentId)
void	setIncidentMessage(String incidentMessage)
void	setIncidentMessageLike(String incidentMessageLike)
void	setIncidentType(String incidentType)
void	setLeafProcessInstances(Boolean leafProcessInstances)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionWithoutTenantId(Boolean isProcessDefinitionWithoutTenantId)
void	setProcessInstanceIds(Set<String> processInstanceIds)
void	setRootProcessInstances(Boolean rootProcessInstances)
void	setSubCaseInstance(String subCaseInstance)
void	setSubProcessInstance(String subProcessInstance)
void	setSuperCaseInstance(String superCaseInstance)
void	setSuperProcessInstance(String superProcessInstance)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIds)
void	setVariables(List<VariableQueryParameterDto> variables)
void	setWithIncident(Boolean withIncident)
void	setWithoutTenantId(Boolean withoutTenantId)

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, sortOptionsValid, sortOrderValueForDirection, toQuery

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

setObjectMapper, setValueBasedOnAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceQueryDto

public ProcessInstanceQueryDto()

ProcessInstanceQueryDto

public ProcessInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                               javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Detail

getProcessInstanceIds

public Set<String> getProcessInstanceIds()

setProcessInstanceIds

public void setProcessInstanceIds(Set<String> processInstanceIds)

getDeploymentId

public String getDeploymentId()

setDeploymentId

public void setDeploymentId(String deploymentId)

getProcessDefinitionKey

public String getProcessDefinitionKey()

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

getBusinessKey

public String getBusinessKey()

setBusinessKey

public void setBusinessKey(String businessKey)

getBusinessKeyLike

public String getBusinessKeyLike()

setBusinessKeyLike

public void setBusinessKeyLike(String businessKeyLike)

getCaseInstanceId

public String getCaseInstanceId()

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

getProcessDefinitionId

public String getProcessDefinitionId()

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

getSuperProcessInstance

public String getSuperProcessInstance()

setSuperProcessInstance

public void setSuperProcessInstance(String superProcessInstance)

getSubProcessInstance

public String getSubProcessInstance()

setSubProcessInstance

public void setSubProcessInstance(String subProcessInstance)

getSuperCaseInstance

public String getSuperCaseInstance()

setSuperCaseInstance

public void setSuperCaseInstance(String superCaseInstance)

getSubCaseInstance

public String getSubCaseInstance()

setSubCaseInstance

public void setSubCaseInstance(String subCaseInstance)

isActive

public Boolean isActive()

setActive

public void setActive(Boolean active)

isSuspended

public Boolean isSuspended()

setSuspended

public void setSuspended(Boolean suspended)

getVariables

public List<VariableQueryParameterDto> getVariables()

setVariables

public void setVariables(List<VariableQueryParameterDto> variables)

isWithIncident

public Boolean isWithIncident()

setWithIncident

public void setWithIncident(Boolean withIncident)

getIncidentId

public String getIncidentId()

setIncidentId

public void setIncidentId(String incidentId)

getIncidentType

public String getIncidentType()

setIncidentType

public void setIncidentType(String incidentType)

getIncidentMessage

public String getIncidentMessage()

setIncidentMessage

public void setIncidentMessage(String incidentMessage)

getIncidentMessageLike

public String getIncidentMessageLike()

setIncidentMessageLike

public void setIncidentMessageLike(String incidentMessageLike)

getTenantIdIn

public List<String> getTenantIdIn()

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

isWithoutTenantId

public Boolean isWithoutTenantId()

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

getActivityIds

public List<String> getActivityIds()

setActivityIdIn

public void setActivityIdIn(List<String> activityIds)

isRootProcessInstances

public Boolean isRootProcessInstances()

setRootProcessInstances

public void setRootProcessInstances(Boolean rootProcessInstances)

isLeafProcessInstances

public Boolean isLeafProcessInstances()

setLeafProcessInstances

public void setLeafProcessInstances(Boolean leafProcessInstances)

isProcessDefinitionWithoutTenantId

public Boolean isProcessDefinitionWithoutTenantId()

setProcessDefinitionWithoutTenantId

public void setProcessDefinitionWithoutTenantId(Boolean isProcessDefinitionWithoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<ProcessInstanceQuery>

createNewQuery

protected ProcessInstanceQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<ProcessInstanceQuery>

applyFilters

protected void applyFilters(ProcessInstanceQuery query)

Specified by:

applyFilters in class AbstractQueryDto<ProcessInstanceQuery>

applySortBy

protected void applySortBy(ProcessInstanceQuery query,
                           String sortBy,
                           Map<String,Object> parameters,
                           ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<ProcessInstanceQuery>