joincontext.java

一个java工作流引擎

package org.jbpm.delegation;

import java.util.*;

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

/**
 * provides the {@link JoinHandler} with the methods to perform synchronization between
 * multiple concurrent paths of execution.
 */
public interface JoinContext extends ExecutionContext {
  
  /**
   * gets all active concurrent flows other then the one 
   * that is actually arriving in the join.
   * @return a Map from String's (the token-names) to Token's.  An empty Map 
   *   is returned of there are no such tokens. 
   */
  Map getOtherActiveBrothersAndSisters();

  /**
   * allows the implementor to search a token based upon the path.
   * @param path is a URL-like expression that resolves to a token.  
   *   E.g.: //child-of-root-token-name/child-of-child-of-root-token-name/...
   *   or a path relative to the token in this execution context.
   *   e.g. ../path-name-one/path-name-two
   * @throws IllegalArgumentException if the path could not be evaluated to a token.
   */
  Token getToken( String path );
  
  /**
   * allows the implementor to reactivate a flow.
   * @throws IllegalStateException if the token was in a state.  When a token
   *   arrives in a fork, it is put in an unassigned-mode until it is reactivated
   *   with this method or until it is cancelled.  Only tokens in unassigned-mode 
   *   can be reactivated.
   */
  void reactivateToken( Token token ) throws ExecutionException;
}