ProcessInstanceModificationInstructionDto (Camunda BPM Javadocs 7.14.20-ee)

java.lang.Object
- org.openapitools.client.model.ProcessInstanceModificationInstructionDto

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

ProcessInstanceModificationInstructionDto

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcessInstanceModificationInstructionDto.TypeEnum
**Mandatory**.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessInstanceModificationInstructionDto.TypeEnum` Mandatory.

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_ANCESTOR_ACTIVITY_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_CANCEL_CURRENT_ACTIVE_ACTIVITY_INSTANCES`
`static String`	`SERIALIZED_NAME_TRANSITION_ID`
`static String`	`SERIALIZED_NAME_TRANSITION_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_VARIABLES`

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceModificationInstructionDto()

Constructors
Constructor and Description
`ProcessInstanceModificationInstructionDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceModificationInstructionDto`	`activityId(String activityId)`
`ProcessInstanceModificationInstructionDto`	`activityInstanceId(String activityInstanceId)`
`ProcessInstanceModificationInstructionDto`	`ancestorActivityInstanceId(String ancestorActivityInstanceId)`
`ProcessInstanceModificationInstructionDto`	`cancelCurrentActiveActivityInstances(Boolean cancelCurrentActiveActivityInstances)`
`boolean`	`equals(Object o)`
`String`	`getActivityId()` Can be used with instructions of types `startTransition`.
`String`	`getActivityInstanceId()` Can be used with instructions of type `cancel`.
`String`	`getAncestorActivityInstanceId()` Can be used with instructions of type `startBeforeActivity`, `startAfterActivity`, and `startTransition`.
`Boolean`	`getCancelCurrentActiveActivityInstances()` Can be used with instructions of type cancel.
`String`	`getTransitionId()` Can be used with instructions of types `startTransition`.
`String`	`getTransitionInstanceId()` Can be used with instructions of type `cancel`.
`ProcessInstanceModificationInstructionDto.TypeEnum`	`getType()` Mandatory.
`TriggerVariableValueDto`	`getVariables()` Get variables
`int`	`hashCode()`
`void`	`setActivityId(String activityId)`
`void`	`setActivityInstanceId(String activityInstanceId)`
`void`	`setAncestorActivityInstanceId(String ancestorActivityInstanceId)`
`void`	`setCancelCurrentActiveActivityInstances(Boolean cancelCurrentActiveActivityInstances)`
`void`	`setTransitionId(String transitionId)`
`void`	`setTransitionInstanceId(String transitionInstanceId)`
`void`	`setType(ProcessInstanceModificationInstructionDto.TypeEnum type)`
`void`	`setVariables(TriggerVariableValueDto variables)`
`String`	`toString()`
`ProcessInstanceModificationInstructionDto`	`transitionId(String transitionId)`
`ProcessInstanceModificationInstructionDto`	`transitionInstanceId(String transitionInstanceId)`
`ProcessInstanceModificationInstructionDto`	`type(ProcessInstanceModificationInstructionDto.TypeEnum type)`
`ProcessInstanceModificationInstructionDto`	`variables(TriggerVariableValueDto variables)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VARIABLES
```
public static final String SERIALIZED_NAME_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACTIVITY_ID
```
public static final String SERIALIZED_NAME_ACTIVITY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSITION_ID
```
public static final String SERIALIZED_NAME_TRANSITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
```
public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSITION_INSTANCE_ID
```
public static final String SERIALIZED_NAME_TRANSITION_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ANCESTOR_ACTIVITY_INSTANCE_ID
```
public static final String SERIALIZED_NAME_ANCESTOR_ACTIVITY_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CANCEL_CURRENT_ACTIVE_ACTIVITY_INSTANCES
```
public static final String SERIALIZED_NAME_CANCEL_CURRENT_ACTIVE_ACTIVITY_INSTANCES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessInstanceModificationInstructionDto
```
public ProcessInstanceModificationInstructionDto()
```
- Method Detail
  - type
```
public ProcessInstanceModificationInstructionDto type(ProcessInstanceModificationInstructionDto.TypeEnum type)
```
  - getType
```
public ProcessInstanceModificationInstructionDto.TypeEnum getType()
```
    **Mandatory**. One of the following values: `cancel`, `startBeforeActivity`, `startAfterActivity`, `startTransition`. * A cancel instruction requests cancellation of a single activity instance or all instances of one activity. * A startBeforeActivity instruction requests to enter a given activity. * A startAfterActivity instruction requests to execute the single outgoing sequence flow of a given activity. * A startTransition instruction requests to execute a specific sequence flow.
    
    Returns:
    
    type
  - setType
```
public void setType(ProcessInstanceModificationInstructionDto.TypeEnum type)
```
  - variables
```
public ProcessInstanceModificationInstructionDto variables(TriggerVariableValueDto variables)
```
  - getVariables
```
@Nullable
public TriggerVariableValueDto getVariables()
```
    Get variables
    
    Returns:
    
    variables
  - setVariables
```
public void setVariables(TriggerVariableValueDto variables)
```
  - activityId
```
public ProcessInstanceModificationInstructionDto activityId(String activityId)
```
  - getActivityId
```
@Nullable
public String getActivityId()
```
    Can be used with instructions of types `startTransition`. Specifies the sequence flow to start.
    
    Returns:
    
    activityId
  - setActivityId
```
public void setActivityId(String activityId)
```
  - transitionId
```
public ProcessInstanceModificationInstructionDto transitionId(String transitionId)
```
  - getTransitionId
```
@Nullable
public String getTransitionId()
```
    Can be used with instructions of types `startTransition`. Specifies the sequence flow to start.
    
    Returns:
    
    transitionId
  - setTransitionId
```
public void setTransitionId(String transitionId)
```
  - activityInstanceId
```
public ProcessInstanceModificationInstructionDto activityInstanceId(String activityInstanceId)
```
  - getActivityInstanceId
```
@Nullable
public String getActivityInstanceId()
```
    Can be used with instructions of type `cancel`. Specifies the activity instance to cancel. Valid values are the activity instance IDs supplied by the [Get Activity Instance request](https://docs.camunda.org/manual/7.14/reference/rest/process-instance/get-activity-instances/).
    
    Returns:
    
    activityInstanceId
  - setActivityInstanceId
```
public void setActivityInstanceId(String activityInstanceId)
```
  - transitionInstanceId
```
public ProcessInstanceModificationInstructionDto transitionInstanceId(String transitionInstanceId)
```
  - getTransitionInstanceId
```
@Nullable
public String getTransitionInstanceId()
```
    Can be used with instructions of type `cancel`. Specifies the transition instance to cancel. Valid values are the transition instance IDs supplied by the [Get Activity Instance request](https://docs.camunda.org/manual/7.14/reference/rest/process-instance/get-activity-instances/).
    
    Returns:
    
    transitionInstanceId
  - setTransitionInstanceId
```
public void setTransitionInstanceId(String transitionInstanceId)
```
  - ancestorActivityInstanceId
```
public ProcessInstanceModificationInstructionDto ancestorActivityInstanceId(String ancestorActivityInstanceId)
```
  - getAncestorActivityInstanceId
```
@Nullable
public String getAncestorActivityInstanceId()
```
    Can be used with instructions of type `startBeforeActivity`, `startAfterActivity`, and `startTransition`. Valid values are the activity instance IDs supplied by the Get Activity Instance request. If there are multiple parent activity instances of the targeted activity, this specifies the ancestor scope in which hierarchy the activity/transition is to be instantiated. Example: When there are two instances of a subprocess and an activity contained in the subprocess is to be started, this parameter allows to specifiy under which subprocess instance the activity should be started.
    
    Returns:
    
    ancestorActivityInstanceId
  - setAncestorActivityInstanceId
```
public void setAncestorActivityInstanceId(String ancestorActivityInstanceId)
```
  - cancelCurrentActiveActivityInstances
```
public ProcessInstanceModificationInstructionDto cancelCurrentActiveActivityInstances(Boolean cancelCurrentActiveActivityInstances)
```
  - getCancelCurrentActiveActivityInstances
```
@Nullable
public Boolean getCancelCurrentActiveActivityInstances()
```
    Can be used with instructions of type cancel. Prevents the deletion of new created activity instances.
    
    Returns:
    
    cancelCurrentActiveActivityInstances
  - setCancelCurrentActiveActivityInstances
```
public void setCancelCurrentActiveActivityInstances(Boolean cancelCurrentActiveActivityInstances)
```
  - 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

Class ProcessInstanceModificationInstructionDto

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_VARIABLES

SERIALIZED_NAME_ACTIVITY_ID

SERIALIZED_NAME_TRANSITION_ID

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID

SERIALIZED_NAME_TRANSITION_INSTANCE_ID

SERIALIZED_NAME_ANCESTOR_ACTIVITY_INSTANCE_ID

SERIALIZED_NAME_CANCEL_CURRENT_ACTIVE_ACTIVITY_INSTANCES

Constructor Detail

ProcessInstanceModificationInstructionDto

Method Detail

type

getType

setType

variables

getVariables

setVariables

activityId

getActivityId

setActivityId

transitionId

getTransitionId

setTransitionId

activityInstanceId

getActivityInstanceId

setActivityInstanceId

transitionInstanceId

getTransitionInstanceId

setTransitionInstanceId

ancestorActivityInstanceId

getAncestorActivityInstanceId

setAncestorActivityInstanceId

cancelCurrentActiveActivityInstances

getCancelCurrentActiveActivityInstances

setCancelCurrentActiveActivityInstances

equals

hashCode

toString