forkcontext.java

一个java工作流引擎

package org.jbpm.delegation;

import org.jbpm.*;
import org.jbpm.model.definition.*;
import org.jbpm.model.execution.*;

/**
 * provides the {@link ForkHandler} with the methods to create tokens for multiple
 * concurrent paths of execution.
 */
public interface ForkContext extends ExecutionContext {

  /**
   * creates a token and launch it over the specified transition
   * leaving the fork.
   * @param transition is a transition leaving the the fork in process.  
   *   Transitions can be obtained with forkContext.getNode().getLeavingTransitions() or
   *   with forkContext.getNode().getLeavingTransition( String transitionName ).
   * @param tokenName is the name given to the token.
   * @throws a IllegalTransitionException if transition is null or not a leaving
   *   transition of the fork.
   */
  Token createToken( Transition transition, String tokenName ) throws ExecutionException;

  /**
   * finds a type from the definition for creating a token-local-variable 
   * by its java-type.
   * @return null if the type was not found.
   */
  Type findTypeByJavaType( String javaType );

  /**
   * finds a type from the definition for creating a token-local-variable 
   * by an example object value.
   * @return null if the type was not found or if the value is null.
   */
  Type findTypeByObject( Object value );

  /**
   * finds a type from the definition for creating a token-local-variable 
   * by a variableName.
   * @return null if the type was not found.
   */
  Type findTypeByVariableName( String variableName );
  
  /**
   * creates a local variable for the token.
   * The value must match at least one of the types that are specified in the definition.
   * If the variableName is already present in one of the parent tokens, it
   * will be hidden in the execution context of the token.
   * @throws IllegalArgumentException if the variable already exists on this token.
   * @throws DefinitionException if the variable serializer used to serialize the value, throws a RuntimeException.
   */
  void createLocalVariable( Token token, String variableName, Type type, Object value );
}