Class ProcessInstanceSuspensionStateDto


  • public class ProcessInstanceSuspensionStateDto
    extends Object
    ProcessInstanceSuspensionStateDto
    • Field Detail

      • SERIALIZED_NAME_PROCESS_DEFINITION_ID

        public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PROCESS_DEFINITION_KEY

        public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID

        public static final String SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

        public static final String SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PROCESS_INSTANCE_IDS

        public static final String SERIALIZED_NAME_PROCESS_INSTANCE_IDS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PROCESS_INSTANCE_QUERY

        public static final String SERIALIZED_NAME_PROCESS_INSTANCE_QUERY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY

        public static final String SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY
        See Also:
        Constant Field Values
    • Constructor Detail

      • ProcessInstanceSuspensionStateDto

        public ProcessInstanceSuspensionStateDto()
    • Method Detail

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        The process definition id of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`.
        Returns:
        processDefinitionId
      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)
      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        The process definition key of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionTenantId`, and `processDefinitionWithoutTenantId`.
        Returns:
        processDefinitionKey
      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)
      • getProcessDefinitionTenantId

        public String getProcessDefinitionTenantId()
        Only activate or suspend process instances of a process definition which belongs to a tenant with the given id. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionWithoutTenantId`.
        Returns:
        processDefinitionTenantId
      • setProcessDefinitionTenantId

        public void setProcessDefinitionTenantId​(String processDefinitionTenantId)
      • getProcessDefinitionWithoutTenantId

        public Boolean getProcessDefinitionWithoutTenantId()
        Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionTenantId`.
        Returns:
        processDefinitionWithoutTenantId
      • setProcessDefinitionWithoutTenantId

        public void setProcessDefinitionWithoutTenantId​(Boolean processDefinitionWithoutTenantId)
      • getProcessInstanceIds

        public List<String> getProcessInstanceIds()
        A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation. **Note**: This parameter can be used only with combination of `suspended`, `processInstanceQuery`, and `historicProcessInstanceQuery`.
        Returns:
        processInstanceIds
      • setProcessInstanceIds

        public void setProcessInstanceIds​(List<String> processInstanceIds)
      • getProcessInstanceQuery

        public ProcessInstanceQueryDto getProcessInstanceQuery()
        Get processInstanceQuery
        Returns:
        processInstanceQuery
      • getHistoricProcessInstanceQuery

        public HistoricProcessInstanceQueryDto getHistoricProcessInstanceQuery()
        Get historicProcessInstanceQuery
        Returns:
        historicProcessInstanceQuery
      • getSuspended

        public Boolean getSuspended()
        A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated.
        Returns:
        suspended
      • setSuspended

        public void setSuspended​(Boolean suspended)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object