1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.engine.node;
17
18 import org.kuali.rice.kew.engine.RouteContext;
19 import org.kuali.rice.kew.engine.RouteHelper;
20
21 /**
22 * A Node type which can be used to dynamically generate a route path for a document.
23 *
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 public interface DynamicNode extends Node {
27
28 /**
29 * Invoked when the engine first encounters this DynamicNode. Should return a {@link DynamicResult} containing
30 * the first {@link RouteNodeInstance} in the dynamic process.
31 */
32 public DynamicResult transitioningInto(RouteContext context, RouteNodeInstance process, RouteHelper helper) throws Exception;
33
34 /**
35 * Invoked everytime a node in the dynamic process completes. Should return a {@link DynamicResult} with the
36 * {@link RouteNodeInstance} (or instances) of the next node in the dynamic graph. If this returns no next
37 * node then the dynamic process will be considered completed.
38 */
39 public DynamicResult transitioningOutOf(RouteContext context, RouteHelper helper) throws Exception;
40
41 }