invocationlog.java

一个java工作流引擎

package org.jbpm.model.log;

import java.io.*;
import java.util.*;
import org.jbpm.model.execution.*;
import org.jbpm.service.*;

/**
 * is a collection of logs for one jBpm-API service method invocation.
 * 
 * <p>The members of this class can be interpreted like this : 
 * An InvocationLog specifies that a jBpm-API-method-call was done
 * on {@link #getProcessInstance()}, {@link #getToken()}.  Before 
 * the invocation, the token was in state {@link #getStateBeforeInvocation()} 
 * and assigned to {@link #getAssignedActorId()}.  Swimlane {@link  #getActorId()} 
 * called method {@link #getServiceMethod()} on {@link #getDate()}. As a result
 * of this invocation, the jbpm engine executed some calculations and actions
 * to determine the next state of the process instance.  Those calculations can 
 * be found in {@link #getExecutionLogs()}. 
 * </p>
 */
public interface InvocationLog extends Serializable {
  
  /**
   * is the id of the log.
   */
	Long getId();

  /**
   * is the process instance upon which the invocation was done.
   */
  ProcessInstance getProcessInstance();
  
  /**
   * is the token on which the invocation was done.  Note : A startProcessInstance method call
   * will be logged on the root token of the created process instance.
   */
	Token getToken();

  /**
   * is the method called.
   */
  ServiceMethod getServiceMethod();
  
  /**
   * is the date of invocation.
   */
	Date getDate();
  
  /**
   * is the swimlane that invoked the jBpm-API service method.
   */
  String getActorId();

  /**
   * is the list of detailed engine execution logs giving insight in the engins' calculation 
   * triggered by the invocation.
   */
  List getExecutionLogs();
}