KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sapia > soto > state > cocoon > CocoonStateMachineComponent


1 package org.sapia.soto.state.cocoon;
2
3 import org.xml.sax.ContentHandler JavaDoc;
4
5 import java.util.Map JavaDoc;
6
7
8 /**
9  * This interface specifies the behavior of components that hold
10  * a state machine.
11  *
12  * @author Yanick Duchesne
13  * <dl>
14  * <dt><b>Copyright:</b><dd>Copyright &#169; 2002-2003 <a HREF="http://www.sapia-oss.org">Sapia Open Source Software</a>. All Rights Reserved.</dd></dt>
15  * <dt><b>License:</b><dd>Read the license.txt file of the jar or visit the
16  * <a HREF="http://www.sapia-oss.org/license.html">license page</a> at the Sapia OSS web site</dd></dt>
17  * </dl>
18  */

19 public interface CocoonStateMachineComponent {
20   public static final String JavaDoc ROLE = "org.sapia.soto.state.cocoon.CocoonStateMachine";
21
22   /**
23    * Executes a state.
24    *
25    * @param state the identifier of the state to execute.
26    * @param objectModel the <code>Map</code> that holds Cocoon's request and response objects.
27    * @param handler the <code>ContentHandler</code> to which SAX events will eventually be sent.
28    * @throws Exception if a problem occurs while executing the flow.
29    */

30   public void execute(String JavaDoc flow, Map JavaDoc objectModel, ContentHandler JavaDoc handler)
31     throws Exception JavaDoc;
32 }
33
Popular Tags