org.camunda.bpm.engine.runtime.UpdateProcessInstancesSuspensionStateBuilder Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.runtime;
import org.camunda.bpm.engine.AuthorizationException;
import org.camunda.bpm.engine.authorization.Permissions;
import org.camunda.bpm.engine.authorization.Resources;
import org.camunda.bpm.engine.batch.Batch;
public interface UpdateProcessInstancesSuspensionStateBuilder extends UpdateProcessInstanceSuspensionStateBuilder, UpdateProcessInstancesRequest {
/**
*
* Activates the provided process instances asynchronously.
*
*
*
* If you have a process instance hierarchy, activating one process instance
* from the hierarchy will not activate other process instances from that
* hierarchy.
*
*
* @throws org.camunda.bpm.engine.BadUserRequestException
* If no process Instances are found
* If a process Instance is set to null
* @throws AuthorizationException
* if the user has no {@link Permissions#CREATE} permission
* on {@link Resources#BATCH}.
*/
Batch activateAsync();
/**
*
* Suspends the provided process instances asynchronously. This means that the execution is
* stopped, so the token state will not change. However, actions that
* do not change token state, like setting/removing variables, etc. will
* succeed.
*
*
*
* Tasks belonging to the suspended process instance will also be suspended.
* This means that any actions influencing the tasks' lifecycles will fail,
* such as
*
* - claiming
* - completing
* - delegation
* - changes in task assignees, owners, etc.
*
* Actions that only change task properties will succeed, such as changing
* variables or adding comments.
*
*
*
* If a process instance is in state suspended, the engine will also not
* execute jobs (timers, messages) associated with this instance.
*
*
*
* If you have a process instance hierarchy, suspending one process instance
* from the hierarchy will not suspend other process instances from that
* hierarchy.
*
*
* @throws org.camunda.bpm.engine.BadUserRequestException
* If no process Instances are found
* If a process Instance is set to null
* @throws AuthorizationException
* if the user has no {@link Permissions#CREATE} permission
* on {@link Resources#BATCH}.
*/
Batch suspendAsync();
}