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 org.andromda.metafacades.uml.FrontEndView;
9
10 /**
11 * Represents a JSF view for a front-end application.
12 *
13 * Metafacade interface to be used by AndroMDA cartridges.
14 */
15 public interface JSFView
16 extends FrontEndView
17 {
18 /**
19 * Indicates the metafacade type (used for metafacade mappings).
20 *
21 * @return boolean always <code>true</code>
22 */
23 public boolean isJSFViewMetaType();
24
25 /**
26 * All those forwards that are actions.
27 * @return List<JSFAction>
28 */
29 public List<JSFAction> getActionForwards();
30
31 /**
32 * All variables that have backing value.
33 * @return List<JSFParameter>
34 */
35 public List<JSFParameter> getBackingValueVariables();
36
37 /**
38 * A resource message key suited for the page's documentation.
39 * @return String
40 */
41 public String getDocumentationKey();
42
43 /**
44 * A resource message value suited for the view's documentation.
45 * @return String
46 */
47 public String getDocumentationValue();
48
49 /**
50 * All actions that have forms associated with them.
51 * @return List<JSFAction>
52 */
53 public List<JSFAction> getFormActions();
54
55 /**
56 * The key that stores the form in which information is passed from one action to another.
57 * @return String
58 */
59 public String getFormKey();
60
61 /**
62 * Gets the forwards which can be targgeted from this view.
63 * @return List<JSFForward>
64 */
65 public List<JSFForward> getForwards();
66
67 /**
68 * The name that corresponds to the from-outcome in an navigational rule.
69 * @return String
70 */
71 public String getFromOutcome();
72
73 /**
74 * TODO: Model Documentation for
75 * org.andromda.cartridges.jsf2.metafacades.JSFView.fullyQualifiedPageObjectClassName
76 * @return String
77 */
78 public String getFullyQualifiedPageObjectClassName();
79
80 /**
81 * TODO: Model Documentation for
82 * org.andromda.cartridges.jsf2.metafacades.JSFView.fullyQualifiedPageObjectClassPath
83 * @return String
84 */
85 public String getFullyQualifiedPageObjectClassPath();
86
87 /**
88 * The fully qualified name of this view's form populator.
89 * @return String
90 */
91 public String getFullyQualifiedPopulator();
92
93 /**
94 * The default resource message key for this view.
95 * @return String
96 */
97 public String getMessageKey();
98
99 /**
100 * A displayable version of this view's name.
101 * @return String
102 */
103 public String getMessageValue();
104
105 /**
106 * TODO: Model Documentation for
107 * org.andromda.cartridges.jsf2.metafacades.JSFView.pageObjectBeanName
108 * @return String
109 */
110 public String getPageObjectBeanName();
111
112 /**
113 * TODO: Model Documentation for
114 * org.andromda.cartridges.jsf2.metafacades.JSFView.pageObjectClassName
115 * @return String
116 */
117 public String getPageObjectClassName();
118
119 /**
120 * The full path of the view resources (i.e. the JSP page).
121 * @return String
122 */
123 public String getPath();
124
125 /**
126 * The name of the form populator for this view.
127 * @return String
128 */
129 public String getPopulator();
130
131 /**
132 * The path to the form populator.
133 * @return String
134 */
135 public String getPopulatorPath();
136
137 /**
138 * A resource message key suited for the view's title.
139 * @return String
140 */
141 public String getTitleKey();
142
143 /**
144 * A default resource message value suited for the page's title.
145 * @return String
146 */
147 public String getTitleValue();
148
149 /**
150 * Indicates whether or not this view has the same name as the use case in which it is
151 * contained.
152 * @return boolean
153 */
154 public boolean isHasNameOfUseCase();
155
156 /**
157 * TODO: Model Documentation for
158 * org.andromda.cartridges.jsf2.metafacades.JSFView.needsFileUpload
159 * @return boolean
160 */
161 public boolean isNeedsFileUpload();
162
163 /**
164 * Indicates whether or not any non-table view variables are present in this view.
165 * @return boolean
166 */
167 public boolean isNonTableVariablesPresent();
168
169 /**
170 * Indicates if a populator is required for this view.
171 * @return boolean
172 */
173 public boolean isPopulatorRequired();
174
175 /**
176 * Indicates if this view represents a popup.
177 * @return boolean
178 */
179 public boolean isPopup();
180
181 /**
182 * Indicates whether or not at least one parameter of an outgoing action in this view requires
183 * validation.
184 * @return boolean
185 */
186 public boolean isValidationRequired();
187 }