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.Collection;
8 import org.andromda.metafacades.uml.ManageableEntityAttribute;
9 import org.andromda.metafacades.uml.ParameterFacade;
10
11 /**
12 * TODO: Model Documentation for
13 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute
14 *
15 * Metafacade interface to be used by AndroMDA cartridges.
16 */
17 public interface JSFManageableEntityAttribute
18 extends ManageableEntityAttribute
19 {
20 /**
21 * Indicates the metafacade type (used for metafacade mappings).
22 *
23 * @return boolean always <code>true</code>
24 */
25 public boolean isJSFManageableEntityAttributeMetaType();
26
27 /**
28 * TODO: Model Documentation for
29 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.backingListName
30 * @return String
31 */
32 public String getBackingListName();
33
34 /**
35 * The String format to use when referring to this date, only makes sense when the type is a
36 * date type.
37 * @return String
38 */
39 public String getDateFormat();
40
41 /**
42 * TODO: Model Documentation for
43 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.dateFormatter
44 * @return String
45 */
46 public String getDateFormatter();
47
48 /**
49 * TODO: Model Documentation for
50 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.defaultDateFormat
51 * @return String
52 */
53 public String getDefaultDateFormat();
54
55 /**
56 * TODO: Model Documentation for
57 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.defaultTimeFormat
58 * @return String
59 */
60 public String getDefaultTimeFormat();
61
62 /**
63 * TODO: Model Documentation for
64 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.dummyValue
65 * @return String
66 */
67 public String getDummyValue();
68
69 /**
70 * Gets the unique id of this attribute on the form.
71 * @param ownerParameter ParameterFacade
72 * @return String
73 */
74 public String getFormPropertyId(ParameterFacade ownerParameter);
75
76 /**
77 * Retrieves the name of the form property for this attribute by taking the name of the owner
78 * property.
79 * @param ownerParameter ParameterFacade
80 * @return String
81 */
82 public String getFormPropertyName(ParameterFacade ownerParameter);
83
84 /**
85 * TODO: Model Documentation for
86 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.format
87 * @return String
88 */
89 public String getFormat();
90
91 /**
92 * TODO: Model Documentation for
93 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputTableIdentifierColumns
94 * @return String
95 */
96 public String getInputTableIdentifierColumns();
97
98 /**
99 * TODO: Model Documentation for
100 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.labelListName
101 * @return String
102 */
103 public String getLabelListName();
104
105 /**
106 * The max length allowed in the input component
107 * @return String
108 */
109 public String getMaxLength();
110
111 /**
112 * TODO: Model Documentation for
113 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.messageKey
114 * @return String
115 */
116 public String getMessageKey();
117
118 /**
119 * TODO: Model Documentation for
120 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.messageValue
121 * @return String
122 */
123 public String getMessageValue();
124
125 /**
126 * The key to lookup the online help documentation. This documentation is gathered from the
127 * documentation entered by the user, as well as analyzing the model.
128 * @return String
129 */
130 public String getOnlineHelpKey();
131
132 /**
133 * The online help documentation. This documentation is gathered from the documentation entered
134 * by the user, as well as analyzing the model. The format is HTML without any style.
135 * @return String
136 */
137 public String getOnlineHelpValue();
138
139 /**
140 * TODO: Model Documentation for
141 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.timeFormatter
142 * @return String
143 */
144 public String getTimeFormatter();
145
146 /**
147 * TODO: Model Documentation for
148 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.validWhen
149 * @return String
150 */
151 public String getValidWhen();
152
153 /**
154 * TODO: Model Documentation for
155 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.getValidatorArgs
156 * @param validatorType String
157 * @return Collection
158 */
159 public Collection getValidatorArgs(String validatorType);
160
161 /**
162 * All validator types for this attribute.
163 * @return Collection
164 */
165 public Collection getValidatorTypes();
166
167 /**
168 * The validator variables.
169 * @return Collection
170 */
171 public Collection getValidatorVars();
172
173 /**
174 * TODO: Model Documentation for
175 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.valueListDummyValue
176 * @return String
177 */
178 public String getValueListDummyValue();
179
180 /**
181 * TODO: Model Documentation for
182 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.valueListName
183 * @return String
184 */
185 public String getValueListName();
186
187 /**
188 * The widget to use when rendering this attribute
189 * @return String
190 */
191 public String getWidgetType();
192
193 /**
194 * Whether or not this attribute should be put in the view
195 * @return boolean
196 */
197 public boolean isEditable();
198
199 /**
200 * TODO: Model Documentation for
201 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.equalValidator
202 * @return boolean
203 */
204 public boolean isEqualValidator();
205
206 /**
207 * Whether or not this attribute should be hidden from the view
208 * @return boolean
209 */
210 public boolean isHidden();
211
212 /**
213 * TODO: Model Documentation for
214 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputCheckbox
215 * @return boolean
216 */
217 public boolean isInputCheckbox();
218
219 /**
220 * TODO: Model Documentation for
221 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputFile
222 * @return boolean
223 */
224 public boolean isInputFile();
225
226 /**
227 * TODO: Model Documentation for
228 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputHidden
229 * @return boolean
230 */
231 public boolean isInputHidden();
232
233 /**
234 * TODO: Model Documentation for
235 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputMultibox
236 * @return boolean
237 */
238 public boolean isInputMultibox();
239
240 /**
241 * TODO: Model Documentation for
242 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputRadio
243 * @return boolean
244 */
245 public boolean isInputRadio();
246
247 /**
248 * TODO: Model Documentation for
249 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputSecret
250 * @return boolean
251 */
252 public boolean isInputSecret();
253
254 /**
255 * TODO: Model Documentation for
256 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputSelect
257 * @return boolean
258 */
259 public boolean isInputSelect();
260
261 /**
262 * TODO: Model Documentation for
263 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputTable
264 * @return boolean
265 */
266 public boolean isInputTable();
267
268 /**
269 * TODO: Model Documentation for
270 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputText
271 * @return boolean
272 */
273 public boolean isInputText();
274
275 /**
276 * TODO: Model Documentation for
277 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputTextarea
278 * @return boolean
279 */
280 public boolean isInputTextarea();
281
282 /**
283 * TODO: Model Documentation for
284 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.inputTypePresent
285 * @return boolean
286 */
287 public boolean isInputTypePresent();
288
289 /**
290 * True if this attribute is of a type that cannot easily be represented as a textual string and
291 * would be an ideal candidate for HTTP's support for file-upload.
292 * @return boolean
293 */
294 public boolean isNeedsFileUpload();
295
296 /**
297 * TODO: Model Documentation for
298 * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntityAttribute.plaintext
299 * @return boolean
300 */
301 public boolean isPlaintext();
302
303 /**
304 * True if this field is a date type and the date format is not be interpreted strictly.
305 * @return boolean
306 */
307 public boolean isStrictDateFormat();
308
309 /**
310 * Indicates whether or not this attribute requires some kind of validation (the collection of
311 * validator types is not empty).
312 * @return boolean
313 */
314 public boolean isValidationRequired();
315 }