View Javadoc

1   package com.explosion.expfmodules.wizard;
2   
3   import java.util.List;
4   import java.util.Map;
5   
6   
7   /* =============================================================================
8    *       
9    *     Copyright 2004 Stephen Cowx
10   *
11   *     Licensed under the Apache License, Version 2.0 (the "License");
12   *     you may not use this file except in compliance with the License.
13   *     You may obtain a copy of the License at
14   *
15   *     http://www.apache.org/licenses/LICENSE-2.0
16   *
17   *     Unless required by applicable law or agreed to in writing, software
18   *     distributed under the License is distributed on an "AS IS" BASIS,
19   *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   *     See the License for the specific language governing permissions and
21   *     limitations under the License.
22   * 
23   * =============================================================================
24   */
25  
26  /***
27   * Created on 01-Dec-2004
28   * 
29   * Each wizard consits of a number of steps.  Each step contains a list of information 
30   * that is to be captured during this step as well as a list of possible routes to the next step after this one.
31   * Each step may also be the first or the last step in a particular route on this wizard. 
32   * 
33   * @author Stephen Cowx
34   */
35  public interface StepDefinition
36  {
37  
38      /***
39       * Returns a reference to the wizard to which this step belongs
40       * @return
41       */
42      public Wizard getWizard();
43      
44      /***
45       * Returns a map of the dataItems in this Step 
46       * @return
47       */
48      public Map getDataItems();
49      
50      /***
51       * Returns a list of the dataItems in this step ordered according to their
52       * preferred display order
53       * @return
54       */
55      public List getOrderedDataItems();
56  
57      /***
58       * Returns the Help text for this class
59       * @return
60       */
61      public String getHelp();
62      
63      /***
64       * notes for this step
65       * @return
66       */
67      public String getNotes();
68      
69      /***
70       * Returns the action for this stpe
71       * @return
72       */
73      public StepAction getAction();
74      
75      /***
76       * Sets the action for this step
77       * @param action
78       */
79      public void setAction(StepAction action);
80      
81      /***
82       * Sets the view for this step
83       * @param view
84       */
85      public void setView(StepView view);
86  
87      /***
88       * Returns the view for this step
89       * @return
90       */
91      public StepView getView();
92  
93      /***
94       * Returns the unique identifier of this step in this wizard
95       * @return
96       */
97      public String getId();
98  
99      /***
100      * Returns the name of this StepDefinition (display name)
101      * @return
102      */
103     public String getName();
104     
105 }
106