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.Collection;
8 import org.andromda.metafacades.uml.ManageableEntity;
9 import org.andromda.metafacades.uml.Role;
10
11 /**
12 * TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity
13 *
14 * Metafacade interface to be used by AndroMDA cartridges.
15 */
16 public interface JSFManageableEntity
17 extends ManageableEntity
18 {
19 /**
20 * Indicates the metafacade type (used for metafacade mappings).
21 *
22 * @return boolean always <code>true</code>
23 */
24 public boolean isJSFManageableEntityMetaType();
25
26 /**
27 * The name of the action class that executes the manageable actions.
28 * @return String
29 */
30 public String getActionClassName();
31
32 /**
33 * The fully qualified path to the action class that execute the manageable actions.
34 * @return String
35 */
36 public String getActionFullPath();
37
38 /**
39 * The path to the action class that execute the manageable actions.
40 * @return String
41 */
42 public String getActionPath();
43
44 /**
45 * TODO: Model Documentation for
46 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.getActionRoles
47 * @return String
48 */
49 public String getActionRoles();
50
51 /**
52 * The calcuated serial version UID for this manageable actions.
53 * @return String
54 */
55 public String getActionSerialVersionUID();
56
57 /**
58 * The fully qualified name of the action class that execute the manageable actions.
59 * @return String
60 */
61 public String getActionType();
62
63 /**
64 * The bean name of this manageable controller (this is what is stored in the JSF configuration
65 * file).
66 * @return String
67 */
68 public String getControllerBeanName();
69
70 /**
71 * Full path of this manageable controller.
72 * @return String
73 */
74 public String getControllerFullPath();
75
76 /**
77 * Manageable controller class name.
78 * @return String
79 */
80 public String getControllerName();
81
82 /**
83 * Fully qualified name of this manageable controller.
84 * @return String
85 */
86 public String getControllerType();
87
88 /**
89 * TODO: Model Documentation for
90 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterClassName
91 * @return String
92 */
93 public String getConverterClassName();
94
95 /**
96 * TODO: Model Documentation for
97 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterFullPath
98 * @return String
99 */
100 public String getConverterFullPath();
101
102 /**
103 * TODO: Model Documentation for
104 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterType
105 * @return String
106 */
107 public String getConverterType();
108
109 /**
110 * TODO: Model Documentation for
111 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionKey
112 * @return String
113 */
114 public String getExceptionKey();
115
116 /**
117 * TODO: Model Documentation for
118 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionPath
119 * @return String
120 */
121 public String getExceptionPath();
122
123 /**
124 * TODO: Model Documentation for
125 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanClassName
126 * @return String
127 */
128 public String getFormBeanClassName();
129
130 /**
131 * TODO: Model Documentation for
132 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanFullPath
133 * @return String
134 */
135 public String getFormBeanFullPath();
136
137 /**
138 * TODO: Model Documentation for
139 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanName
140 * @return String
141 */
142 public String getFormBeanName();
143
144 /**
145 * TODO: Model Documentation for
146 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanType
147 * @return String
148 */
149 public String getFormBeanType();
150
151 /**
152 * The calcuated serial version UID for this action's form.
153 * @return String
154 */
155 public String getFormSerialVersionUID();
156
157 /**
158 * TODO: Model Documentation for
159 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listGetterName
160 * @return String
161 */
162 public String getListGetterName();
163
164 /**
165 * TODO: Model Documentation for
166 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listName
167 * @return String
168 */
169 public String getListName();
170
171 /**
172 * TODO: Model Documentation for
173 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listSetterName
174 * @return String
175 */
176 public String getListSetterName();
177
178 /**
179 * TODO: Model Documentation for
180 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAssociationEnds
181 * @return Collection
182 */
183 public Collection getManageableSearchAssociationEnds();
184
185 /**
186 * TODO: Model Documentation for
187 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAttributes
188 * @return Collection
189 */
190 public Collection getManageableSearchAttributes();
191
192 /**
193 * TODO: Model Documentation for
194 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageKey
195 * @return String
196 */
197 public String getMessageKey();
198
199 /**
200 * TODO: Model Documentation for
201 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageValue
202 * @return String
203 */
204 public String getMessageValue();
205
206 /**
207 * TODO: Model Documentation for
208 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.odsExportFullPath
209 * @return String
210 */
211 public String getOdsExportFullPath();
212
213 /**
214 * The full path to this entity's online help action. The returned String does not have a suffix
215 * such as '.do'.
216 * @return String
217 */
218 public String getOnlineHelpActionPath();
219
220 /**
221 * The key to lookup the online help documentation.
222 * @return String
223 */
224 public String getOnlineHelpKey();
225
226 /**
227 * The full path to this entitiy's online help page. The returned String does not have a suffix
228 * such as '.jsp'.
229 * @return String
230 */
231 public String getOnlineHelpPagePath();
232
233 /**
234 * The online help documentation. The format is HTML without any style.
235 * @return String
236 */
237 public String getOnlineHelpValue();
238
239 /**
240 * TODO: Model Documentation for
241 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorFullPath
242 * @return String
243 */
244 public String getPopulatorFullPath();
245
246 /**
247 * TODO: Model Documentation for
248 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorName
249 * @return String
250 */
251 public String getPopulatorName();
252
253 /**
254 * TODO: Model Documentation for
255 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorType
256 * @return String
257 */
258 public String getPopulatorType();
259
260 /**
261 * Represents a role a user may play within a system. Provides access to things such as
262 * services and
263 * service operations.
264 * @return Collection<Role>
265 */
266 public Collection<Role> getRoles();
267
268 /**
269 * TODO: Model Documentation for
270 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanClassName
271 * @return String
272 */
273 public String getSearchFormBeanClassName();
274
275 /**
276 * TODO: Model Documentation for
277 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanFullPath
278 * @return String
279 */
280 public String getSearchFormBeanFullPath();
281
282 /**
283 * TODO: Model Documentation for
284 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanName
285 * @return String
286 */
287 public String getSearchFormBeanName();
288
289 /**
290 * TODO: Model Documentation for
291 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanType
292 * @return String
293 */
294 public String getSearchFormBeanType();
295
296 /**
297 * Tthe available types of export in a single String instance.
298 * @return String
299 */
300 public String getTableExportTypes();
301
302 /**
303 * The maximum number of rows to be displayed in the table at the same time. This is also known
304 * as the page size. A value of zero or less will display all data in the same table (therefore
305 * also on the same page).
306 * @return int
307 */
308 public int getTableMaxRows();
309
310 /**
311 * TODO: Model Documentation for
312 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.valueObjectClassName
313 * @return String
314 */
315 public String getValueObjectClassName();
316
317 /**
318 * TODO: Model Documentation for
319 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewFullPath
320 * @return String
321 */
322 public String getViewFullPath();
323
324 /**
325 * TODO: Model Documentation for
326 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewName
327 * @return String
328 */
329 public String getViewName();
330
331 /**
332 * TODO: Model Documentation for
333 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleKey
334 * @return String
335 */
336 public String getViewTitleKey();
337
338 /**
339 * TODO: Model Documentation for
340 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleValue
341 * @return String
342 */
343 public String getViewTitleValue();
344
345 /**
346 * TODO: Model Documentation for
347 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsFileUpload
348 * @return boolean
349 */
350 public boolean isNeedsFileUpload();
351
352 /**
353 * TODO: Model Documentation for
354 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsUserInterface
355 * @return boolean
356 */
357 public boolean isNeedsUserInterface();
358
359 /**
360 * TODO: Model Documentation for
361 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.preload
362 * @return boolean
363 */
364 public boolean isPreload();
365
366 /**
367 * TODO: Model Documentation for
368 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.isSearchable
369 * @param element Object
370 * @return boolean
371 */
372 public boolean isSearchable(Object element);
373
374 /**
375 * True if it is possible to export the table data to XML, CSV, PDF or Excel format.
376 * @return boolean
377 */
378 public boolean isTableExportable();
379
380 /**
381 * True if it is possible to sort the columns of the table.
382 * @return boolean
383 */
384 public boolean isTableSortable();
385
386 /**
387 * TODO: Model Documentation for
388 * org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.validationRequired
389 * @return boolean
390 */
391 public boolean isValidationRequired();
392 }