src.openwfe.org.engine.expressions.state.ExpressionState Maven / Gradle / Ivy
/*
* Copyright (c) 2001-2006, 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: ExpressionState.java 2668 2006-05-25 15:15:15Z jmettraux $
*/
//
// ExpressionState.java
//
// [email protected]
//
// generated with
// jtmpl 1.1.01 2004/05/19 ([email protected])
//
package openwfe.org.engine.expressions.state;
import openwfe.org.engine.expool.ExpressionPool;
import openwfe.org.engine.workitem.InFlowWorkItem;
import openwfe.org.engine.expressions.FlowExpression;
import openwfe.org.engine.expressions.ApplyException;
import openwfe.org.engine.expressions.ReplyException;
/**
* The first implementation of this interface is 'FrozenState', this
* implementation will take care of keeping the applied/replied workitem frozen
* until
*
* CVS Info :
*
$Author: jmettraux $
*
$Id: ExpressionState.java 2668 2006-05-25 15:15:15Z jmettraux $
*
* @author [email protected]
*/
public interface ExpressionState
extends java.io.Serializable
{
/**
* Sets a reference to the flow expression in this state.
*/
public void setExpression (FlowExpression fe);
/**
* Returns since how many millisecs this state is active for its [client]
* expression.
*/
public long getSince ();
/**
* Returns a one char identifier for the state (for example 'f' for frozen)
*/
public char getIdentifier ();
/**
* Returns a short name for the expression, like 'frozen' or 'paused'.
*/
public String getName ();
public void apply (InFlowWorkItem wi)
throws ApplyException;
public void reply (InFlowWorkItem wi)
throws ReplyException;
/**
* The equivalent of FlowExpression.cancel(), will also return a workitem
* if the underlying expression was handling a workitem when cancelled.
*/
public InFlowWorkItem cancel ()
throws ApplyException;
/**
* Makes this expression leave this state.
*/
public void exitState ()
throws ApplyException;
}