executionreadservice.java

一个java工作流引擎

package org.jbpm;

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

/**
 * is the read-only part of the execution service.
 */
public interface ExecutionReadService {
	
	/**
	 * collects all {@link org.jbpm.workflow.execution.Flow}s for which the given 
	 * target-swimlane has to perform an activity.
   * @param targetActorId specifies the swimlane for which the tasklist should be fetched.
   * @param assembler specifies which related objects should be available to the client.  
   *   This parameter can be null if no other then the returned object is accessed.
   *   See {@link Assemcler} for more info.
	 * @return a Collection of {@link org.jbpm.workflow.execution.Flow}s which are 
	 *   assigned to given swimlane.
	 * @throws java.lang.NullPointerException if targetActorId is null.
	 * @throws org.jbpm.PersistenceException if jbpm cannot contact its database.
	 */
  Collection getTaskList( String targetActorId, Assembler assembler );

  /**
   * retrieves the specified {@link Token}.
   * @param tokenId the id of the token.
   * @param assembler specifies which related objects should be available to the client.  
   *   This parameter can be null if no other then the returned object is accessed.
   *   See {@link Assemcler} for more info.
   * @throws java.lang.NullPointerException if tokenId is null.
   * @throws org.jbpm.PersistenceException if jbpm cannot contact its database.
   */
  Token getToken( Long tokenId, Assembler assembler );

  /**
   * retrieves the specified {@link ProcessInstance}.
   * @param processInstanceId the id of the process instance.
   * @param assembler specifies which related objects should be available to the client.  
   *   This parameter can be null if no other then the returned object is accessed.
   *   See {@link Assembler} for more info.
   * @throws java.lang.NullPointerException if processInstanceId is null.
   * @throws org.jbpm.PersistenceException if jbpm cannot contact its database.
   */
  ProcessInstance getProcessInstance( Long processInstanceId, Assembler assembler );
  
  /**
   * retrieves the variables of the specified {@link Token}.
   * @return a Map from variable-names (String) to variable-values (Object).
   *   If no variables exist in the token, an empty Map is returned.
   * @param tokenId the id of the token for which the variables should be retrieved.
   * @throws java.lang.NullPointerException if tokenId is null.
   * @throws org.jbpm.PersistenceException if jbpm cannot contact its database.
   */
  Map getVariables( Long tokenId );

  /**
   * retrieves a definition from an id. 
   */
  Definition getDefinition(Long definitionId, Assembler assembler);

  /**
   * retrieves the latest version of the process definition with the given name.
   */
  Definition getLatestDefinition( String name );
  
  /**
   * retrieves only the latest versions of all the process definitions in the system.
   */
  Collection getLatestDefinitions();

  /**
   * provides access to the files in the process archive.
   */
  byte[] getFile( Long processDefinitionId, String fileName );

}