01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.php
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package edu.iu.uis.eden.engine.node;
18:
19: import edu.iu.uis.eden.engine.RouteContext;
20: import edu.iu.uis.eden.engine.RouteHelper;
21:
22: /**
23: * A Node type which can be used to dynamically generate a route path for a document.
24: *
25: * @author rkirkend
26: * @author ewestfal
27: */
28: public interface DynamicNode extends Node {
29:
30: /**
31: * Invoked when the engine first encounters this DynamicNode. Should return a {@link DynamicResult} containing
32: * the first {@link RouteNodeInstance} in the dynamic process.
33: */
34: public DynamicResult transitioningInto(RouteContext context,
35: RouteNodeInstance process, RouteHelper helper)
36: throws Exception;
37:
38: /**
39: * Invoked everytime a node in the dynamic process completes. Should return a {@link DynamicResult} with the
40: * {@link RouteNodeInstance} (or instances) of the next node in the dynamic graph. If this returns no next
41: * node then the dynamic process will be considered completed.
42: */
43: public DynamicResult transitioningOutOf(RouteContext context,
44: RouteHelper helper) throws Exception;
45:
46: }
|