org.camunda.bpm.engine.impl.pvm.delegate.ActivityExecution Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; 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.impl.pvm.delegate;
import java.util.List;
import java.util.Map;
import org.camunda.bpm.engine.delegate.DelegateExecution;
import org.camunda.bpm.engine.impl.cmmn.execution.CmmnCaseInstance;
import org.camunda.bpm.engine.impl.cmmn.model.CmmnCaseDefinition;
import org.camunda.bpm.engine.impl.pvm.PvmActivity;
import org.camunda.bpm.engine.impl.pvm.PvmProcessDefinition;
import org.camunda.bpm.engine.impl.pvm.PvmProcessInstance;
import org.camunda.bpm.engine.impl.pvm.PvmScope;
import org.camunda.bpm.engine.impl.pvm.PvmTransition;
import org.camunda.bpm.engine.impl.pvm.process.ScopeImpl;
import org.camunda.bpm.engine.impl.pvm.process.TransitionImpl;
import org.camunda.bpm.engine.impl.pvm.runtime.PvmExecutionImpl;
/**
* @author Tom Baeyens
* @author Joram Barrez
* @author Daniel Meyer
* @author Falko Menge
*/
public interface ActivityExecution extends DelegateExecution {
/* Process instance/activity/transition retrieval */
/**
* returns the current {@link PvmActivity} of the execution.
*/
PvmActivity getActivity();
/** invoked to notify the execution that a new activity instance is started */
void enterActivityInstance();
/** invoked to notify the execution that an activity instance is ended. */
void leaveActivityInstance();
void setActivityInstanceId(String id);
/** return the Id of the activity instance currently executed by this execution */
String getActivityInstanceId();
/** return the Id of the parent activity instance currently executed by this execution */
String getParentActivityInstanceId();
/* Execution management */
/**
* creates a new execution. This execution will be the parent of the newly created execution.
* properties processDefinition, processInstance and activity will be initialized.
*/
ActivityExecution createExecution();
/**
* creates a new execution. This execution will be the parent of the newly created execution.
* properties processDefinition, processInstance and activity will be initialized.
*/
ActivityExecution createExecution(boolean initializeExecutionStartContext);
/**
* creates a new sub process instance.
* The current execution will be the super execution of the created execution.
*
* @param processDefinition The {@link PvmProcessDefinition} of the subprocess.
*/
PvmProcessInstance createSubProcessInstance(PvmProcessDefinition processDefinition);
/**
* @see #createSubProcessInstance(PvmProcessDefinition)
*
* @param processDefinition The {@link PvmProcessDefinition} of the subprocess.
* @param businessKey the business key of the process instance
*/
PvmProcessInstance createSubProcessInstance(PvmProcessDefinition processDefinition, String businessKey);
/**
* @see #createSubProcessInstance(PvmProcessDefinition)
*
* @param processDefinition The {@link PvmProcessDefinition} of the subprocess.
* @param businessKey the business key of the process instance
* @param caseInstanceId the case instance id of the process instance
*/
PvmProcessInstance createSubProcessInstance(PvmProcessDefinition processDefinition, String businessKey, String caseInstanceId);
/**
* Creates a new sub case instance.
*
* This execution will be the super execution of the
* created sub case instance.
*
* @param caseDefinition The {@link CmmnCaseDefinition} of the sub case instance.
*/
CmmnCaseInstance createSubCaseInstance(CmmnCaseDefinition caseDefinition);
/**
* Creates a new sub case instance.
*
* This execution will be the super execution of the
* created sub case instance.
*
* @param caseDefinition The {@link CmmnCaseDefinition} of the sub case instance.
* @param businessKey The businessKey to be set on sub case instance.
*/
CmmnCaseInstance createSubCaseInstance(CmmnCaseDefinition caseDefinition, String businessKey);
/**
* returns the parent of this execution, or null if there no parent.
*/
ActivityExecution getParent();
/**
* returns the list of execution of which this execution the parent of.
* This is a copy of the actual list, so a modification has no direct effect.
*/
List getExecutions();
/**
* returns child executions that are not event scope executions.
*/
List getNonEventScopeExecutions();
/**
* @return true if this execution has child executions (event scope executions or not)
*/
boolean hasChildren();
/**
* ends this execution.
*/
void end(boolean isScopeComplete);
/**
* Execution finished compensation. Removes this
* execution and notifies listeners.
*/
void endCompensation();
/* State management */
/**
* makes this execution active or inactive.
*/
void setActive(boolean isActive);
/**
* returns whether this execution is currently active.
*/
boolean isActive();
/**
* returns whether this execution has ended or not.
*/
boolean isEnded();
/**
* changes the concurrent indicator on this execution.
*/
void setConcurrent(boolean isConcurrent);
/**
* returns whether this execution is concurrent or not.
*/
boolean isConcurrent();
/**
* returns whether this execution is a process instance or not.
*/
boolean isProcessInstanceExecution();
/**
* Inactivates this execution.
* This is useful for example in a join: the execution
* still exists, but it is not longer active.
*/
void inactivate();
/**
* Returns whether this execution is a scope.
*/
boolean isScope();
/**
* Changes whether this execution is a scope or not
*/
void setScope(boolean isScope);
/**
* Returns whether this execution completed the parent scope.
*/
boolean isCompleteScope();
/**
* Retrieves all executions which are concurrent and inactive at the given activity.
*/
List findInactiveConcurrentExecutions(PvmActivity activity);
List findInactiveChildExecutions(PvmActivity activity);
/**
* Takes the given outgoing transitions, and potentially reusing
* the given list of executions that were previously joined.
*/
void leaveActivityViaTransitions(List outgoingTransitions, List joinedExecutions);
void leaveActivityViaTransition(PvmTransition outgoingTransition);
/**
* Executes the {@link ActivityBehavior} associated with the given activity.
*/
void executeActivity(PvmActivity activity);
/**
* Called when an execution is interrupted. This will remove all associated entities
* such as event subscriptions, jobs, ...
*/
void interrupt(String reason);
/** An activity which is to be started next. */
PvmActivity getNextActivity();
void remove();
void destroy();
void signal(String string, Object signalData);
void setActivity(PvmActivity activity);
boolean tryPruneLastConcurrentChild();
void forceUpdate();
TransitionImpl getTransition();
/**
* Assumption: the current execution is active and executing an activity ({@link #getActivity()} is not null).
*
* For a given target scope, this method returns the scope execution.
*
* @param targetScope scope activity or process definition for which the scope execution should be found;
* must be an ancestor of the execution's current activity
* @return
*/
public ActivityExecution findExecutionForFlowScope(PvmScope targetScope);
/**
* Returns a mapping from scope activities to scope executions for all scopes that
* are ancestors of the activity currently executed by this execution.
*
* Assumption: the current execution is active and executing an activity ({@link #getActivity()} is not null).
*/
public Map createActivityExecutionMapping();
void setEnded(boolean b);
}