/*
    *  DISCLAIMER
    */
   package org.flowfuse.base.model;
   
   import com.opensymphony.workflow.spi.Step;
   import org.apache.commons.logging.Log;
   import org.apache.commons.logging.LogFactory;
   import org.flowfuse.base.Constants;
  import org.flowfuse.base.services.workflow.WorkflowService;
  import org.flowfuse.base.services.workitem.WorkItemManagementService;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  import java.io.Serializable;
  
  /***
   * <p>An instance of <code>Workflow</code> contains workflow data of
   * a particular work item. It contains information about the current
   * step(s), status and possible workflow actions as well as past steps and
   * workflow actions. Instances of this class are not persisted it self,
   * but act as a wrapper for lower level object from the OS Workflow
   * engine.</p>
   *
   * @author <a href="stefan@flowfuse.org">Stefan Kleineikenscheidt</a>,
   *         Flowfuse.org
   * @since 1.0
   * @version $Id: Workflow.java,v 1.3 2005/12/12 21:34:19 skleinei Exp $
   */
  public class Workflow implements Serializable {
  
    /***
     * RCS ID
     */
    public final static String rcsid = "$Id: Workflow.java,v 1.3 2005/12/12 21:34:19 skleinei Exp $";
  
    /***
     * Logger
     */
    protected final Log logger = LogFactory.getLog(this.getClass());
  
    /***
     * The <code>WorkItem</code> this <code>Workflow</code> belongs to.
     */
    private WorkItem workItem = null;
  
    /***
     * The Spring Modules OsWorkflowTemplate which encapsulates OS
     * Workflow's stateles Workflow.
     */
    private WorkflowService workflowService = null;
  
    private WorkItemManagementService workItemManagementService = null;
  
    /***
     * Constructs a new Workflow instance.
     *
     * @param workItem Reference to the associated WorkItem
     */
    public Workflow(WorkItem workItem) {
      this.workItem = workItem;
    }
  
    /***
     * <p>Returns the state of the <code>Workflow</code>.</p>
     *
     * @return The <code>Workflow</code>'s state.
     */
    public int getState() {
      return this.workflowService.getEntryState();
    }
  
    /***
     * <p>Returns a list of current <code>WorkflowSteps</code> for this
     * workflow. Most of the time, this will be just one current step - only
     * in case of splits multiple steps are returned.</p>
     *
     * @return List of current workflow steps for this workflow.
     * @see WorkflowStep
     * @since 1.0
     */
    public List getCurrentSteps() {
      List currentSteps = null;
      List currentWorkflowSteps = new ArrayList();
  
      currentSteps = this.workflowService.getCurrentSteps();
  
      for (int i = 0; i < currentSteps.size(); i++) {
        Object o = (Object) currentSteps.get(i);
        Step step = (Step) o;
  
        WorkflowStep workflowStep = new WorkflowStep(step,
                this.workflowService.getWorkflowDescriptor());
        currentWorkflowSteps.add(workflowStep);
      }
  
      return currentWorkflowSteps;
   }
 
   /***
    * <p>Returns a list of history <code>WorkflowSteps</code> for this
    * workflow.</p>
    *
    * @return List of history workflow steps for this workflow.
    * @see WorkflowStep
    * @since 1.0
    */
   public List getHistorySteps() {
     List historySteps = null;
     List historyWorkflowSteps = new ArrayList();
 
     historySteps = this.workflowService.getHistorySteps();
 
     for (int i = 0; i < historySteps.size(); i++) {
       Object o = (Object) historySteps.get(i);
       Step step = (Step) o;
 
       WorkflowStep workflowStep = new WorkflowStep(step,
               this.workflowService.getWorkflowDescriptor());
       historyWorkflowSteps.add(workflowStep);
     }
 
     return historyWorkflowSteps;
   }
 
   /***
    * <p>Returns a list of available <code>WorkflowActions</code> for this
    * workflow.</p>
    *
    * @return List of available workflow actions for this workflow.
    * @see WorkflowAction
    * @since 1.0
    */
   public List getAvailableActions() {
     return getAvailableActions(null);
   }
 
   /***
    * <p>Returns a list of available <code>WorkflowActions</code> for this
    * workflow.</p>
    *
    * @param inputs Map of parameters which may limit the resulting
    *         actions. May be null.
    * @return List of available workflow actions for this workflow.
    * @see WorkflowAction
    * @since 1.0
    */
   public List getAvailableActions(Map inputs) {
     int[] availableActionIds;
     List availableActions = new ArrayList();
 
     availableActionIds =
             this.workflowService.getAvailableActions(inputs);
 
     for (int i = 0; i < availableActionIds.length; i++) {
       int actionId = availableActionIds[i];
       WorkflowAction action = new WorkflowAction(actionId,
               this.workflowService.getWorkflowDescriptor());
       availableActions.add(action);
     }
 
     return availableActions;
   }
 
   public void startWorkflow() {
     Map inputs = new HashMap();
     inputs.put(Constants.WF_FUNCTION_WORKFLOWDATA, this.workItem);
     /*inputs.put(Constants.WF_PERSISTENCE_MANAGER,
             this.workItemManagementService);*/
     this.workflowService.initialize(2801, inputs);
   }
 
   public void executeWorkflowAction(WorkflowAction workflowAction,
           Map inputs) {
     /*inputs.put(Constants.WF_PERSISTENCE_MANAGER,
             this.workItemManagementService);*/
     inputs.put(Constants.WF_FUNCTION_WORKFLOWDATA, this.workItem);
     this.workflowService.doAction(workflowAction.getId(), inputs);
   }
 
   public WorkflowAction getWorkflowAction(int id) {
     return new WorkflowAction(id,
             this.workflowService.getWorkflowDescriptor());
   }
 
   /***
    * Retrieves dependency (see <a href="http://www.springframework.org">
    * http://www.springframework.org</a>).
    *
    * @return
    */
   public WorkflowService getWorkflowService() {
     return workflowService;
   }
 
   /***
    * Injects dependency (see <a href="http://www.springframework.org">
    * http://www.springframework.org</a>).
    */
   public void setWorkflowService(WorkflowService workflowService) {
     this.workflowService = workflowService;
   }
 
   /***
    * Retrieves dependency (see <a href="http://www.springframework.org">
    * http://www.springframework.org</a>).
    *
    * @return
    */
   public WorkItemManagementService getWorkflowManagementService() {
     return workItemManagementService;
   }
 
   /***
    * Injects dependency (see <a href="http://www.springframework.org">
    * http://www.springframework.org</a>).
    */
   public void setWorkflowManagementService(
           WorkItemManagementService workItemManagementService) {
     this.workItemManagementService = workItemManagementService;
   }
 }
 
 /* EOF */