001    /*
002     * Copyright 2005-2008 The Kuali Foundation
003     * 
004     * 
005     * Licensed under the Educational Community License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * You may obtain a copy of the License at
008     * 
009     * http://www.opensource.org/licenses/ecl2.php
010     * 
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.kuali.rice.kew.engine.node;
018    
019    import org.kuali.rice.kew.engine.RouteContext;
020    import org.kuali.rice.kew.engine.RouteHelper;
021    
022    /**
023     * A Node type which can be used to dynamically generate a route path for a document.
024     * 
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface DynamicNode extends Node {
028    
029            /**
030             * Invoked when the engine first encounters this DynamicNode.  Should return a {@link DynamicResult} containing 
031             * the first {@link RouteNodeInstance} in the dynamic process.
032             */
033            public DynamicResult transitioningInto(RouteContext context, RouteNodeInstance process, RouteHelper helper) throws Exception;
034            
035            /**
036             * Invoked everytime a node in the dynamic process completes.  Should return a {@link DynamicResult} with the 
037             * {@link RouteNodeInstance} (or instances) of the next node in the dynamic graph.  If this returns no next 
038             * node then the dynamic process will be considered completed.
039             */
040            public DynamicResult transitioningOutOf(RouteContext context, RouteHelper helper) throws Exception;
041            
042    }