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