1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.jsf.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 * The fully qualified name of this view's form populator.
75 * @return String
76 */
77 public String getFullyQualifiedPopulator();
78
79 /**
80 * The default resource message key for this view.
81 * @return String
82 */
83 public String getMessageKey();
84
85 /**
86 * A displayable version of this view's name.
87 * @return String
88 */
89 public String getMessageValue();
90
91 /**
92 * The full path of the view resources (i.e. the JSP page).
93 * @return String
94 */
95 public String getPath();
96
97 /**
98 * The name of the form populator for this view.
99 * @return String
100 */
101 public String getPopulator();
102
103 /**
104 * The path to the form populator.
105 * @return String
106 */
107 public String getPopulatorPath();
108
109 /**
110 * A resource message key suited for the view's title.
111 * @return String
112 */
113 public String getTitleKey();
114
115 /**
116 * A default resource message value suited for the page's title.
117 * @return String
118 */
119 public String getTitleValue();
120
121 /**
122 * Indicates whether or not this view has the same name as the use case in which it is
123 * contained.
124 * @return boolean
125 */
126 public boolean isHasNameOfUseCase();
127
128 /**
129 * TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFView.needsFileUpload
130 * @return boolean
131 */
132 public boolean isNeedsFileUpload();
133
134 /**
135 * Indicates whether or not any non-table view variables are present in this view.
136 * @return boolean
137 */
138 public boolean isNonTableVariablesPresent();
139
140 /**
141 * Indicates if a populator is required for this view.
142 * @return boolean
143 */
144 public boolean isPopulatorRequired();
145
146 /**
147 * Indicates if this view represents a popup.
148 * @return boolean
149 */
150 public boolean isPopup();
151
152 /**
153 * Indicates whether or not at least one parameter of an outgoing action in this view requires
154 * validation.
155 * @return boolean
156 */
157 public boolean isValidationRequired();
158 }