worklist.java

一个工作流设计及定义的系统,可以直接与数据库结合进行系统工作流程的定义及应用.

/*
 * Copyright (c) 2005, John Mettraux, OpenWFE.org
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * . Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.  
 * 
 * . Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation 
 *   and/or other materials provided with the distribution.
 * 
 * . Neither the name of the "OpenWFE" nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: Worklist.java,v 1.1 2005/07/27 11:02:58 jmettraux Exp $
 */

//
// Worklist.java
//
// [e-mail]
//
// generated with 
// jtmpl 1.1.01 2004/05/19 ([e-mail])
//

package openwfe.org.embed.worklist;

import openwfe.org.engine.workitem.InFlowWorkItem;
import openwfe.org.engine.expressions.FlowExpressionId;
import openwfe.org.worklist.WorkListException;
import openwfe.org.embed.engine.EmbeddedParticipant;


/**
 * The interface for an embedded worklist, it extends EmbeddedParticipant
 * so that the registerParticipant() method of the embedded engine can be
 * used.
 *
 * <p><font size=2>CVS Info :
 * <br>$Author: jmettraux $
 * <br>$Id: Worklist.java,v 1.1 2005/07/27 11:02:58 jmettraux Exp $ </font>
 *
 * @author [e-mail]
 */
public interface Worklist

    extends EmbeddedParticipant

{

    /**
     * Returns how much workitems are stored in this list.
     */
    public int countWorkItems ()
        throws WorkListException;

    /**
     * An iterator on the stored workitems themselves.
     */
    public java.util.Iterator iterator ()
        throws WorkListException;

    /**
     * Returns a workitem from its given id.
     */
    public InFlowWorkItem get (FlowExpressionId fei)
        throws WorkListException;

    /**
     * Saves a workitem.
     */
    public void save (InFlowWorkItem wi)
        throws WorkListException;

    /**
     * Forwards a workitem (make it proceed in its flow).
     */
    public void forward (InFlowWorkItem wi)
        throws WorkListException;

}