View Javadoc

1   package com.explosion.expfmodules.wizard;
2   
3   import java.util.List;
4   
5   
6   /* =============================================================================
7    *       
8    *     Copyright 2004 Stephen Cowx
9    *
10   *     Licensed under the Apache License, Version 2.0 (the "License");
11   *     you may not use this file except in compliance with the License.
12   *     You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *     Unless required by applicable law or agreed to in writing, software
17   *     distributed under the License is distributed on an "AS IS" BASIS,
18   *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *     See the License for the specific language governing permissions and
20   *     limitations under the License.
21   * 
22   * =============================================================================
23   */
24  
25  /***
26   * @author Stephen Cowx
27   * Created on 24-Dec-2004
28   * A Step represents a single stopover in a partricular route.
29   * 
30   * It has reference to the step at this stop and a reference to the possible 
31   * outward bound routes as well as a method for determining the next step on the route
32   * based on the outcome from the previous step.
33   */
34  public interface Step
35  {
36      /***
37       * Allows the caller to set the list of possible routes from this route
38       * @return
39       */
40      public void setOutboundSteps(List steps);
41      
42      /***
43       * Returns the list of possible routes from this route
44       * @return
45       */
46      public List getOutboundSteps();
47      
48      /***
49       * Returns the StepDefinition associated with this stage in the route
50       * @return
51       */
52      public StepDefinition getStepDefinition();
53      
54      /***
55       * This method returns the condition for running this step.
56       */
57      public Condition getCondition();
58      
59      /***
60       * This method sets the condition for running this step.
61       */
62      public void setCondition(Condition condition);
63         
64       
65  }