1
2
3
4 package org.andromda.cartridges.bpm4struts.metafacades;
5
6 /***
7 * <p>
8 * A Struts JSP represents a page in the web application. A page
9 * possibly contains several forms and triggers (either buttons or
10 * hyperlinks) that call actions.
11 * </p>
12 *
13 * Metafacade interface to be used by AndroMDA cartridges.
14 */
15 public interface StrutsJsp
16 extends org.andromda.cartridges.bpm4struts.metafacades.StrutsActionState, org.andromda.metafacades.uml.FrontEndView
17 {
18
19 /***
20 * Indicates the metafacade type (used for metafacade mappings).
21 *
22 * @return always <code>true</code>
23 */
24 public boolean isStrutsJspMetaType();
25
26 /***
27 * <p>
28 * The name of the file containing specific styles for this page
29 * only.
30 * </p>
31 */
32 public java.lang.String getCssFileName();
33
34 /***
35 * <p>
36 * A resource message key suited for the page's documentation.
37 * </p>
38 */
39 public java.lang.String getDocumentationKey();
40
41 /***
42 * <p>
43 * A resource message value suited for the page's documentation.
44 * </p>
45 */
46 public java.lang.String getDocumentationValue();
47
48 /***
49 * <p>
50 * The full path to this JSP page. the returned String does not
51 * have a suffix such as '.jsp'.
52 * </p>
53 */
54 public java.lang.String getFullPath();
55
56 /***
57 * <p>
58 * Returns all actions that possibly result in returning this page.
59 * </p>
60 */
61 public java.util.List getIncomingActions();
62
63 /***
64 * <p>
65 * The default resource message key.
66 * </p>
67 */
68 public java.lang.String getMessageKey();
69
70 /***
71 * <p>
72 * A displayable version of this page's name.
73 * </p>
74 */
75 public java.lang.String getMessageValue();
76
77 /***
78 * <p>
79 * The collection of outgoing forwards that are not actions.
80 * </p>
81 */
82 public java.util.List getNonActionForwards();
83
84 /***
85 * <p>
86 * The full path to this JSP's online help action. The returned
87 * String does not have a suffix such as '.do'.
88 * </p>
89 */
90 public java.lang.String getOnlineHelpActionPath();
91
92 /***
93 * <p>
94 * The key to lookup the online help documentation. This
95 * documentation is gathered from the documentation entered by the
96 * user, as well as analyzing the model.
97 * </p>
98 */
99 public java.lang.String getOnlineHelpKey();
100
101 /***
102 * <p>
103 * The full path to this JSP's online help page. The returned
104 * String does not have a suffix such as '.jsp'.
105 * </p>
106 */
107 public java.lang.String getOnlineHelpPagePath();
108
109 /***
110 * <p>
111 * The online help documentation. This documentation is gathered
112 * from the documentation entered by the user, as well as analyzing
113 * the model. The format is HTML without any style.
114 * </p>
115 */
116 public java.lang.String getOnlineHelpValue();
117
118 /***
119 * <p>
120 * Returns all those variables that will be present as variables in
121 * the target page. These are the trigger parameters on the
122 * incoming transitions.
123 * </p>
124 */
125 public java.util.List getPageVariables();
126
127 /***
128 * <p>
129 * The table page-variables contained in this page.
130 * </p>
131 */
132 public java.util.List getTables();
133
134 /***
135 * <p>
136 * A resource message key suited for the page's title.
137 * </p>
138 */
139 public java.lang.String getTitleKey();
140
141 /***
142 * <p>
143 * A default resource message value suited for the page's title.
144 * </p>
145 */
146 public java.lang.String getTitleValue();
147
148 /***
149 * <p>
150 * True if this JSP contains a date field which requires a calendar
151 * popup.
152 * </p>
153 */
154 public boolean isCalendarRequired();
155
156 /***
157 * <p>
158 * True if any of the actions have a parameter of type Date.
159 * </p>
160 */
161 public boolean isDateFieldPresent();
162
163 /***
164 * <p>
165 * True if at least one client/server parameter requires
166 * validation.
167 * </p>
168 */
169 public boolean isValidationRequired();
170
171 }