org.openapitools.client.model

Class HistoricActivityInstanceQueryDto

java.lang.Object

org.openapitools.client.model.HistoricActivityInstanceQueryDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-04-27T12:13:44.667+02:00[Europe/Berlin]")
public class HistoricActivityInstanceQueryDto
extends Object

A historic activity instance query which defines a group of historic activity instances

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACTIVITY_ID
static String	SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
static String	SERIALIZED_NAME_ACTIVITY_NAME
static String	SERIALIZED_NAME_ACTIVITY_TYPE
static String	SERIALIZED_NAME_CANCELED
static String	SERIALIZED_NAME_COMPLETE_SCOPE
static String	SERIALIZED_NAME_EXECUTION_ID
static String	SERIALIZED_NAME_FINISHED
static String	SERIALIZED_NAME_FINISHED_AFTER
static String	SERIALIZED_NAME_FINISHED_BEFORE
static String	SERIALIZED_NAME_PROCESS_DEFINITION_ID
static String	SERIALIZED_NAME_PROCESS_INSTANCE_ID
static String	SERIALIZED_NAME_SORTING
static String	SERIALIZED_NAME_STARTED_AFTER
static String	SERIALIZED_NAME_STARTED_BEFORE
static String	SERIALIZED_NAME_TASK_ASSIGNEE
static String	SERIALIZED_NAME_TENANT_ID_IN
static String	SERIALIZED_NAME_UNFINISHED
static String	SERIALIZED_NAME_WITHOUT_TENANT_ID

Constructor Summary

Constructors

Constructor and Description
HistoricActivityInstanceQueryDto()

Method Summary

Modifier and Type	Method and Description
HistoricActivityInstanceQueryDto	activityId(String activityId)
HistoricActivityInstanceQueryDto	activityInstanceId(String activityInstanceId)
HistoricActivityInstanceQueryDto	activityName(String activityName)
HistoricActivityInstanceQueryDto	activityType(String activityType)
HistoricActivityInstanceQueryDto	addSortingItem(HistoricActivityInstanceQueryDtoSorting sortingItem)
HistoricActivityInstanceQueryDto	addTenantIdInItem(String tenantIdInItem)
HistoricActivityInstanceQueryDto	canceled(Boolean canceled)
HistoricActivityInstanceQueryDto	completeScope(Boolean completeScope)
boolean	equals(Object o)
HistoricActivityInstanceQueryDto	executionId(String executionId)
HistoricActivityInstanceQueryDto	finished(Boolean finished)
HistoricActivityInstanceQueryDto	finishedAfter(Date finishedAfter)
HistoricActivityInstanceQueryDto	finishedBefore(Date finishedBefore)
String	getActivityId() Filter by the activity id (according to BPMN 2.0 XML).
String	getActivityInstanceId() Filter by activity instance id.
String	getActivityName() Filter by the activity name (according to BPMN 2.0 XML).
String	getActivityType() Filter by activity type.
Boolean	getCanceled() Only include canceled activity instances.
Boolean	getCompleteScope() Only include activity instances which completed a scope.
String	getExecutionId() Filter by the id of the execution that executed the activity instance.
Boolean	getFinished() Only include finished activity instances.
Date	getFinishedAfter() Restrict to instances that were finished after the given date.
Date	getFinishedBefore() Restrict to instances that were finished before the given date.
String	getProcessDefinitionId() Filter by process definition id.
String	getProcessInstanceId() Filter by process instance id.
List<HistoricActivityInstanceQueryDtoSorting>	getSorting() Apply sorting of the result
Date	getStartedAfter() Restrict to instances that were started after the given date.
Date	getStartedBefore() Restrict to instances that were started before the given date.
String	getTaskAssignee() Only include activity instances that are user tasks and assigned to a given user.
List<String>	getTenantIdIn() Must be a JSON array of Strings.
Boolean	getUnfinished() Only include unfinished activity instances.
Boolean	getWithoutTenantId() Only include historic activity instances that belong to no tenant.
int	hashCode()
HistoricActivityInstanceQueryDto	processDefinitionId(String processDefinitionId)
HistoricActivityInstanceQueryDto	processInstanceId(String processInstanceId)
void	setActivityId(String activityId)
void	setActivityInstanceId(String activityInstanceId)
void	setActivityName(String activityName)
void	setActivityType(String activityType)
void	setCanceled(Boolean canceled)
void	setCompleteScope(Boolean completeScope)
void	setExecutionId(String executionId)
void	setFinished(Boolean finished)
void	setFinishedAfter(Date finishedAfter)
void	setFinishedBefore(Date finishedBefore)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceId(String processInstanceId)
void	setSorting(List<HistoricActivityInstanceQueryDtoSorting> sorting)
void	setStartedAfter(Date startedAfter)
void	setStartedBefore(Date startedBefore)
void	setTaskAssignee(String taskAssignee)
void	setTenantIdIn(List<String> tenantIdIn)
void	setUnfinished(Boolean unfinished)
void	setWithoutTenantId(Boolean withoutTenantId)
HistoricActivityInstanceQueryDto	sorting(List<HistoricActivityInstanceQueryDtoSorting> sorting)
HistoricActivityInstanceQueryDto	startedAfter(Date startedAfter)
HistoricActivityInstanceQueryDto	startedBefore(Date startedBefore)
HistoricActivityInstanceQueryDto	taskAssignee(String taskAssignee)
HistoricActivityInstanceQueryDto	tenantIdIn(List<String> tenantIdIn)
String	toString()
HistoricActivityInstanceQueryDto	unfinished(Boolean unfinished)
HistoricActivityInstanceQueryDto	withoutTenantId(Boolean withoutTenantId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID

public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_INSTANCE_ID

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_EXECUTION_ID

public static final String SERIALIZED_NAME_EXECUTION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_ID

public static final String SERIALIZED_NAME_ACTIVITY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_NAME

public static final String SERIALIZED_NAME_ACTIVITY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_TYPE

public static final String SERIALIZED_NAME_ACTIVITY_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_TASK_ASSIGNEE

public static final String SERIALIZED_NAME_TASK_ASSIGNEE

See Also:

Constant Field Values

SERIALIZED_NAME_FINISHED

public static final String SERIALIZED_NAME_FINISHED

See Also:

Constant Field Values

SERIALIZED_NAME_UNFINISHED

public static final String SERIALIZED_NAME_UNFINISHED

See Also:

Constant Field Values

SERIALIZED_NAME_CANCELED

public static final String SERIALIZED_NAME_CANCELED

See Also:

Constant Field Values

SERIALIZED_NAME_COMPLETE_SCOPE

public static final String SERIALIZED_NAME_COMPLETE_SCOPE

See Also:

Constant Field Values

SERIALIZED_NAME_STARTED_BEFORE

public static final String SERIALIZED_NAME_STARTED_BEFORE

See Also:

Constant Field Values

SERIALIZED_NAME_STARTED_AFTER

public static final String SERIALIZED_NAME_STARTED_AFTER

See Also:

Constant Field Values

SERIALIZED_NAME_FINISHED_BEFORE

public static final String SERIALIZED_NAME_FINISHED_BEFORE

See Also:

Constant Field Values

SERIALIZED_NAME_FINISHED_AFTER

public static final String SERIALIZED_NAME_FINISHED_AFTER

See Also:

Constant Field Values

SERIALIZED_NAME_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SORTING

public static final String SERIALIZED_NAME_SORTING

See Also:

Constant Field Values

Constructor Detail

HistoricActivityInstanceQueryDto

public HistoricActivityInstanceQueryDto()

Method Detail

activityInstanceId

public HistoricActivityInstanceQueryDto activityInstanceId(String activityInstanceId)

getActivityInstanceId

@Nullable
public String getActivityInstanceId()

Filter by activity instance id.

Returns:

activityInstanceId

setActivityInstanceId

public void setActivityInstanceId(String activityInstanceId)

processInstanceId

public HistoricActivityInstanceQueryDto processInstanceId(String processInstanceId)

getProcessInstanceId

@Nullable
public String getProcessInstanceId()

Filter by process instance id.

Returns:

processInstanceId

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

processDefinitionId

public HistoricActivityInstanceQueryDto processDefinitionId(String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

Filter by process definition id.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

executionId

public HistoricActivityInstanceQueryDto executionId(String executionId)

getExecutionId

@Nullable
public String getExecutionId()

Filter by the id of the execution that executed the activity instance.

Returns:

executionId

setExecutionId

public void setExecutionId(String executionId)

activityId

public HistoricActivityInstanceQueryDto activityId(String activityId)

getActivityId

@Nullable
public String getActivityId()

Filter by the activity id (according to BPMN 2.0 XML).

Returns:

activityId

setActivityId

public void setActivityId(String activityId)

activityName

public HistoricActivityInstanceQueryDto activityName(String activityName)

getActivityName

@Nullable
public String getActivityName()

Filter by the activity name (according to BPMN 2.0 XML).

Returns:

activityName

setActivityName

public void setActivityName(String activityName)

activityType

public HistoricActivityInstanceQueryDto activityType(String activityType)

getActivityType

@Nullable
public String getActivityType()

Filter by activity type.

Returns:

activityType

setActivityType

public void setActivityType(String activityType)

taskAssignee

public HistoricActivityInstanceQueryDto taskAssignee(String taskAssignee)

getTaskAssignee

@Nullable
public String getTaskAssignee()

Only include activity instances that are user tasks and assigned to a given user.

Returns:

taskAssignee

setTaskAssignee

public void setTaskAssignee(String taskAssignee)

finished

public HistoricActivityInstanceQueryDto finished(Boolean finished)

getFinished

@Nullable
public Boolean getFinished()

Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.

Returns:

finished

setFinished

public void setFinished(Boolean finished)

unfinished

public HistoricActivityInstanceQueryDto unfinished(Boolean unfinished)

getUnfinished

@Nullable
public Boolean getUnfinished()

Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.

Returns:

unfinished

setUnfinished

public void setUnfinished(Boolean unfinished)

canceled

public HistoricActivityInstanceQueryDto canceled(Boolean canceled)

getCanceled

@Nullable
public Boolean getCanceled()

Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.

Returns:

canceled

setCanceled

public void setCanceled(Boolean canceled)

completeScope

public HistoricActivityInstanceQueryDto completeScope(Boolean completeScope)

getCompleteScope

@Nullable
public Boolean getCompleteScope()

Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set.

Returns:

completeScope

setCompleteScope

public void setCompleteScope(Boolean completeScope)

startedBefore

public HistoricActivityInstanceQueryDto startedBefore(Date startedBefore)

getStartedBefore

@Nullable
public Date getStartedBefore()

Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.14/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

startedBefore

setStartedBefore

public void setStartedBefore(Date startedBefore)

startedAfter

public HistoricActivityInstanceQueryDto startedAfter(Date startedAfter)

getStartedAfter

@Nullable
public Date getStartedAfter()

Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.14/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

startedAfter

setStartedAfter

public void setStartedAfter(Date startedAfter)

finishedBefore

public HistoricActivityInstanceQueryDto finishedBefore(Date finishedBefore)

getFinishedBefore

@Nullable
public Date getFinishedBefore()

Restrict to instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.14/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

finishedBefore

setFinishedBefore

public void setFinishedBefore(Date finishedBefore)

finishedAfter

public HistoricActivityInstanceQueryDto finishedAfter(Date finishedAfter)

getFinishedAfter

@Nullable
public Date getFinishedAfter()

Restrict to instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.14/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

finishedAfter

setFinishedAfter

public void setFinishedAfter(Date finishedAfter)

tenantIdIn

public HistoricActivityInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

addTenantIdInItem

public HistoricActivityInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

getTenantIdIn

@Nullable
public List<String> getTenantIdIn()

Must be a JSON array of Strings. An activity instance must have one of the given tenant ids.

Returns:

tenantIdIn

setTenantIdIn

public void setTenantIdIn(List<String> tenantIdIn)

withoutTenantId

public HistoricActivityInstanceQueryDto withoutTenantId(Boolean withoutTenantId)

getWithoutTenantId

@Nullable
public Boolean getWithoutTenantId()

Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior.

Returns:

withoutTenantId

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

sorting

public HistoricActivityInstanceQueryDto sorting(List<HistoricActivityInstanceQueryDtoSorting> sorting)

addSortingItem

public HistoricActivityInstanceQueryDto addSortingItem(HistoricActivityInstanceQueryDtoSorting sortingItem)

getSorting

@Nullable
public List<HistoricActivityInstanceQueryDtoSorting> getSorting()

Apply sorting of the result

Returns:

sorting

setSorting

public void setSorting(List<HistoricActivityInstanceQueryDtoSorting> sorting)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object