Package org.camunda.community.rest.client.dto

Class ProcessInstanceModificationInstructionDto

java.lang.Object
org.camunda.community.rest.client.dto.ProcessInstanceModificationInstructionDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class ProcessInstanceModificationInstructionDto extends Object
ProcessInstanceModificationInstructionDto

  • Field Details

  • Constructor Details

    • ProcessInstanceModificationInstructionDto

      public ProcessInstanceModificationInstructionDto()

  • Method Details

    • type

      public ProcessInstanceModificationInstructionDto type(ProcessInstanceModificationInstructionDto.TypeEnum type)

    • getType

      @Nonnull 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

    • getActivityId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityId_JsonNullable()

    • setActivityId_JsonNullable

      public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getTransitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTransitionId_JsonNullable()

    • setTransitionId_JsonNullable

      public void setTransitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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.21/reference/rest/process-instance/get-activity-instances/).
      Returns:
      activityInstanceId

    • getActivityInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityInstanceId_JsonNullable()

    • setActivityInstanceId_JsonNullable

      public void setActivityInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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.21/reference/rest/process-instance/get-activity-instances/).
      Returns:
      transitionInstanceId

    • getTransitionInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTransitionInstanceId_JsonNullable()

    • setTransitionInstanceId_JsonNullable

      public void setTransitionInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getAncestorActivityInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getAncestorActivityInstanceId_JsonNullable()

    • setAncestorActivityInstanceId_JsonNullable

      public void setAncestorActivityInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getCancelCurrentActiveActivityInstances_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getCancelCurrentActiveActivityInstances_JsonNullable()

    • setCancelCurrentActiveActivityInstances_JsonNullable

      public void setCancelCurrentActiveActivityInstances_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string