cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ovi...@apache.org
Subject cvs commit: xml-cocoon2/src/scratchpad/schecoon/src/org/apache/cocoon/components/flow ContinuationsManager.java
Date Thu, 21 Mar 2002 23:11:55 GMT
ovidiu      02/03/21 15:11:55

  Added:       src/scratchpad/schecoon/src/org/apache/cocoon/components/flow
                        ContinuationsManager.java
  Log:
  Created. Maintains the WebContinuation instances.
  
  Revision  Changes    Path
  1.1                  xml-cocoon2/src/scratchpad/schecoon/src/org/apache/cocoon/components/flow/ContinuationsManager.java
  
  Index: ContinuationsManager.java
  ===================================================================
  package org.apache.cocoon.components.flow;
  
  /**
   * The interface of the Continuations manager.
   *
   * The continuation manager maintains a forrest of {@link
   * WebContinuation} trees. Each tree defines the flow of control for a
   * user within the application.
   * 
   * A <code>WebContinuation</code> is created for a continuation object
   * from the scripting language used. A continuation object in the
   * implementation of the scripting language is an opaque object
   * here. It is only stored inside the <code>WebContinuation</code>,
   * without being interpreted in any way.
   *
   * @author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>
   * @since March 19, 2002
   * @see WebContinuation
   */
  public interface ContinuationsManager
  {
    public final String ROLE = "org.apache.cocoon.components.flow.ContinuationsManager";
  
    /**
     * Create a <code>WebContinuation</code> object given a native
     * continuation object and its parent. If the parent continuation is
     * null, the <code>WebContinuation</code> returned becomes the root
     * of a tree in the forrest.
     *
     * @param kont an <code>Object</code> value
     * @param parentKont a <code>WebContinuation</code> value
     * @return a <code>WebContinuation</code> value
     * @see WebContinuation
     */
    public WebContinuation createWebContinuation(Object kont,
                                                 WebContinuation parentKont);
  
    /**
     * Invalidates a <code>WebContinuation</code>. This effectively
     * means that the continuation object associated with it will no
     * longer be accessible from Web pages. Invalidating a
     * <code>WebContinuation</code> invalidates all the
     * <code>WebContinuation</code>s which are children of it.
     *
     * @param k a <code>WebContinuation</code> value
     */
    public void invalidateWebContinuation(WebContinuation k);
  
    /**
     * Given a <code>WebContinuation</code> id, retrieve the associated
     * <code>WebContinuation</code> object.
     *
     * @param id a <code>String</code> value
     * @return a <code>WebContinuation</code> object, or null if no such
     * <code>WebContinuation</code> could be found.
     */
    public WebContinuation lookupWebContinuation(String id);
  }
  
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org


Mime
View raw message