View Javadoc

1   /* ===================================================================
2    * Copyright 2002-04 SRI International.
3    * Released under the MOZILLA PUBLIC LICENSE Version 1.1
4    * which can be obtained at http://www.mozilla.org/MPL/MPL-1.1.html
5    * This software is distributed on an "AS IS"
6    * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
7    * See the License for the specific language governing rights and
8    * limitations under the License.
9    * =================================================================== */
10  package com.sri.emo.wizard;
11  
12  
13  /***
14   * Metadata for any wizard page.
15   *
16   * @author Michael Rimov
17   */
18  public interface PageMetadata {
19      /***
20       * Return link instance, <code>NullLink</code> if there is no finish
21       * link on this page.
22       *
23       * @return Link instance for 'finish' operations.
24       */
25      Link getFinish();
26  
27      /***
28       * Return link instance, <code>NullLink</code> if there is no finish
29       * link on this page.
30       *
31       * @return Link instance for 'next' operations.
32       */
33      Link getNext();
34  
35      /***
36       * Return link instance, <code>NullLink</code> if there is no finish
37       * link on this page.
38       *
39       * @return Link instance for 'previous' operations.
40       */
41      Link getPrevious();
42  
43      /***
44       * Return link instance, <code>NullLink</code> if there is no finish
45       * link on this page.
46       *
47       * @return Link instance for 'cancel' operations.
48       */
49      Link getCancel();
50  
51      /***
52       * Return the page title.
53       *
54       * @return java.lang.String
55       */
56      String getTitle();
57  
58      /***
59       * Get the page directions.
60       *
61       * @return java.lang.String.
62       */
63      String getDirective();
64  
65      /***
66       * Get the page help text.
67       *
68       * @return java.lang.String
69       */
70      String getHelpText();
71  
72      /***
73       * Set to true if the page has text entry.
74       *
75       * @return boolean true if there should be some sort of entry on the page,
76       *         whether menu, text, or otherwise.  If a page's menu
77       *         is null and hasEntry() is true, then there should be a text box
78       *         on the page.
79       */
80      boolean isHasEntry();
81  
82  
83      /***
84       * Retrurn false if the user can skip a step without entering anything.
85       *
86       * @return boolean true/false
87       */
88      boolean isEntryRequired();
89  
90      /***
91       * Retrieve a view id that corresponds to Struts/JSF/whatever special
92       * view.  Most of the time this will be null.  Otherwise the executor of
93       * the wizard (ie contorller) should consider the results listed here
94       * when it comes to rendering the page.
95       *
96       * @return String
97       */
98      String getViewId();
99  
100 }