1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.jsf2.metafacades;
6
7 import java.util.List;
8 import java.util.Map;
9 import org.andromda.metafacades.uml.FrontEndAction;
10
11 /**
12 * Represents an action taken during a "front-end" event execution on a JSF application.
13 *
14 * Metafacade interface to be used by AndroMDA cartridges.
15 */
16 public interface JSFAction
17 extends FrontEndAction
18 {
19 /**
20 * Indicates the metafacade type (used for metafacade mappings).
21 *
22 * @return boolean always <code>true</code>
23 */
24 public boolean isJSFActionMetaType();
25
26 /**
27 * The name of the action class that executes this action.
28 * @return String
29 */
30 public String getActionClassName();
31
32 /**
33 * The name of the action on the controller that executions this action.
34 * @return String
35 */
36 public String getControllerAction();
37
38 /**
39 * A resource message key suited for the action''s documentation.
40 * @return String
41 */
42 public String getDocumentationKey();
43
44 /**
45 * The resource messsage value suited for the action''s documentation.
46 * @return String
47 */
48 public String getDocumentationValue();
49
50 /**
51 * The name of the bean under which the form is stored.
52 * @return String
53 */
54 public String getFormBeanName();
55
56 /**
57 * The signature of the accessor method that returns the form implementation instance.
58 * @return String
59 */
60 public String getFormImplementationGetter();
61
62 /**
63 * A comma separated list of all the form interfaces which the form implementation implements.
64 * @return String
65 */
66 public String getFormImplementationInterfaceList();
67
68 /**
69 * The name of the form implementation.
70 * @return String
71 */
72 public String getFormImplementationName();
73
74 /**
75 * The key that stores the form in which information is passed from one action to another.
76 * @return String
77 */
78 public String getFormKey();
79
80 /**
81 * The scope of the JSF form (request, session,application,etc).
82 * @return String
83 */
84 public String getFormScope();
85
86 /**
87 * The calcuated serial version UID for this action's form.
88 * @return String
89 */
90 public String getFormSerialVersionUID();
91
92 /**
93 * The name that corresponds to the from-outcome in an navigational rule.
94 * @return String
95 */
96 public String getFromOutcome();
97
98 /**
99 * The fully qualified name of the action class that execute this action.
100 * @return String
101 */
102 public String getFullyQualifiedActionClassName();
103
104 /**
105 * The fully qualified path to the action class that execute this action.
106 * @return String
107 */
108 public String getFullyQualifiedActionClassPath();
109
110 /**
111 * The fully qualified name of the form implementation.
112 * @return String
113 */
114 public String getFullyQualifiedFormImplementationName();
115
116 /**
117 * The fully qualified path of the form implementation.
118 * @return String
119 */
120 public String getFullyQualifiedFormImplementationPath();
121
122 /**
123 * All parameters that are of hidden input type.
124 * @return List<JSFParameter>
125 */
126 public List<JSFParameter> getHiddenParameters();
127
128 /**
129 * The default resource message key for this action.
130 * @return String
131 */
132 public String getMessageKey();
133
134 /**
135 * The path to this action.
136 * @return String
137 */
138 public String getPath();
139
140 /**
141 * The path's root.
142 * @return String
143 */
144 public String getPathRoot();
145
146 /**
147 * Messages used to indicate successful execution.
148 * @return Map
149 */
150 public Map getSuccessMessages();
151
152 /**
153 * The name of the column targetted by this action.
154 * @return String
155 */
156 public String getTableLinkColumnName();
157
158 /**
159 * The name of the table link specified for this action.
160 * @return String
161 */
162 public String getTableLinkName();
163
164 /**
165 * If the action is a table link then this property represents the table to which is being
166 * linked.
167 * @return JSFParameter
168 */
169 public JSFParameter getTableLinkParameter();
170
171 /**
172 * The name of the method to be executed when this action is triggered.
173 * @return String
174 */
175 public String getTriggerMethodName();
176
177 /**
178 * The name of the trigger that triggers that action.
179 * @return String
180 */
181 public String getTriggerName();
182
183 /**
184 * The path to the view fragment corresponding to this action
185 * @return String
186 */
187 public String getViewFragmentPath();
188
189 /**
190 * Any messages used to indicate a warning.
191 * @return Map
192 */
193 public Map getWarningMessages();
194
195 /**
196 * Indicates if this action forwards to a dialog (use case runs in different conversation
197 * scope). Only applied when the target is a final state pointing to another use case.
198 * @return boolean
199 */
200 public boolean isDialog();
201
202 /**
203 * Indicates whether or not a final state is the target of this action.
204 * @return boolean
205 */
206 public boolean isFinalStateTarget();
207
208 /**
209 * Whether or not the entire form should be reset (all action parameters on the form).
210 * @return boolean
211 */
212 public boolean isFormReset();
213
214 /**
215 * Indicates if at least one parameter on the form requires being reset.
216 * @return boolean
217 */
218 public boolean isFormResetRequired();
219
220 /**
221 * Indicates whether or not this action is represented by clicking on a hyperlink.
222 * @return boolean
223 */
224 public boolean isHyperlink();
225
226 /**
227 * TODO: Model Documentation for
228 * org.andromda.cartridges.jsf2.metafacades.JSFAction.needsFileUpload
229 * @return boolean
230 */
231 public boolean isNeedsFileUpload();
232
233 /**
234 * Indicates if this action forwards to a popup. Only applied when the target is a final state
235 * pointing to another use case.
236 * @return boolean
237 */
238 public boolean isPopup();
239
240 /**
241 * Indicates whether or not the values passed along with this action can be reset or not.
242 * @return boolean
243 */
244 public boolean isResettable();
245
246 /**
247 * Indicates whether or not any success messags are present.
248 * @return boolean
249 */
250 public boolean isSuccessMessagesPresent();
251
252 /**
253 * Indicates that this action works on all rows of the table from the table link relation.
254 * @return boolean
255 */
256 public boolean isTableAction();
257
258 /**
259 * Indicates if a table link name has been specified and it properly targets a table
260 * page-variable from the input page.
261 * @return boolean
262 */
263 public boolean isTableLink();
264
265 /**
266 * Indicates whether or not at least one parameter on this action requires validation.
267 * @return boolean
268 */
269 public boolean isValidationRequired();
270
271 /**
272 * Whether or not any warning messages are present.
273 * @return boolean
274 */
275 public boolean isWarningMessagesPresent();
276 }