001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.jsf2.metafacades;
006
007import java.util.Collection;
008import org.andromda.metafacades.uml.ManageableEntity;
009import org.andromda.metafacades.uml.Role;
010
011/**
012 * TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity
013 *
014 * Metafacade interface to be used by AndroMDA cartridges.
015 */
016public interface JSFManageableEntity
017    extends ManageableEntity
018{
019    /**
020     * Indicates the metafacade type (used for metafacade mappings).
021     *
022     * @return boolean always <code>true</code>
023     */
024    public boolean isJSFManageableEntityMetaType();
025
026    /**
027     * The name of the action class that executes the manageable actions.
028     * @return String
029     */
030    public String getActionClassName();
031
032    /**
033     * The fully qualified path to the action class that execute the manageable actions.
034     * @return String
035     */
036    public String getActionFullPath();
037
038    /**
039     * The path to the action class that execute the manageable actions.
040     * @return String
041     */
042    public String getActionPath();
043
044    /**
045     * TODO: Model Documentation for
046     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.getActionRoles
047     * @return String
048     */
049    public String getActionRoles();
050
051    /**
052     * The calcuated serial version UID for this manageable actions.
053     * @return String
054     */
055    public String getActionSerialVersionUID();
056
057    /**
058     * The fully qualified name of the action class that execute the manageable actions.
059     * @return String
060     */
061    public String getActionType();
062
063    /**
064     * The bean name of this manageable controller (this is what is stored in the JSF configuration
065     * file).
066     * @return String
067     */
068    public String getControllerBeanName();
069
070    /**
071     * Full path of this manageable controller.
072     * @return String
073     */
074    public String getControllerFullPath();
075
076    /**
077     * Manageable controller class name.
078     * @return String
079     */
080    public String getControllerName();
081
082    /**
083     * Fully qualified name of this manageable controller.
084     * @return String
085     */
086    public String getControllerType();
087
088    /**
089     * TODO: Model Documentation for
090     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.converterClassName
091     * @return String
092     */
093    public String getConverterClassName();
094
095    /**
096     * TODO: Model Documentation for
097     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.converterFullPath
098     * @return String
099     */
100    public String getConverterFullPath();
101
102    /**
103     * TODO: Model Documentation for
104     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.converterType
105     * @return String
106     */
107    public String getConverterType();
108
109    /**
110     * TODO: Model Documentation for
111     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.exceptionKey
112     * @return String
113     */
114    public String getExceptionKey();
115
116    /**
117     * TODO: Model Documentation for
118     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.exceptionPath
119     * @return String
120     */
121    public String getExceptionPath();
122
123    /**
124     * TODO: Model Documentation for
125     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.formBeanClassName
126     * @return String
127     */
128    public String getFormBeanClassName();
129
130    /**
131     * TODO: Model Documentation for
132     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.formBeanFullPath
133     * @return String
134     */
135    public String getFormBeanFullPath();
136
137    /**
138     * TODO: Model Documentation for
139     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.formBeanName
140     * @return String
141     */
142    public String getFormBeanName();
143
144    /**
145     * TODO: Model Documentation for
146     * org.andromda.cartridges.jsf2.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.jsf2.metafacades.JSFManageableEntity.listGetterName
160     * @return String
161     */
162    public String getListGetterName();
163
164    /**
165     * TODO: Model Documentation for
166     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.listName
167     * @return String
168     */
169    public String getListName();
170
171    /**
172     * TODO: Model Documentation for
173     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.listSetterName
174     * @return String
175     */
176    public String getListSetterName();
177
178    /**
179     * returns all editable attributes
180     * @return Collection
181     */
182    public Collection getManageableEditAttributes();
183
184    /**
185     * TODO: Model Documentation for
186     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.manageableSearchAssociationEnds
187     * @return Collection
188     */
189    public Collection getManageableSearchAssociationEnds();
190
191    /**
192     * TODO: Model Documentation for
193     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.manageableSearchAttributes
194     * @return Collection
195     */
196    public Collection getManageableSearchAttributes();
197
198    /**
199     * TODO: Model Documentation for
200     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.messageKey
201     * @return String
202     */
203    public String getMessageKey();
204
205    /**
206     * TODO: Model Documentation for
207     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.messageValue
208     * @return String
209     */
210    public String getMessageValue();
211
212    /**
213     * TODO: Model Documentation for
214     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.odsExportFullPath
215     * @return String
216     */
217    public String getOdsExportFullPath();
218
219    /**
220     * The full path to this entity's online help action. The returned String does not have a suffix
221     * such as '.do'.
222     * @return String
223     */
224    public String getOnlineHelpActionPath();
225
226    /**
227     * The key to lookup the online help documentation.
228     * @return String
229     */
230    public String getOnlineHelpKey();
231
232    /**
233     * The full path to this entitiy's online help page. The returned String does not have a suffix
234     * such as '.jsp'.
235     * @return String
236     */
237    public String getOnlineHelpPagePath();
238
239    /**
240     * The online help documentation. The format is HTML without any style.
241     * @return String
242     */
243    public String getOnlineHelpValue();
244
245    /**
246     * TODO: Model Documentation for
247     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.populatorFullPath
248     * @return String
249     */
250    public String getPopulatorFullPath();
251
252    /**
253     * TODO: Model Documentation for
254     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.populatorName
255     * @return String
256     */
257    public String getPopulatorName();
258
259    /**
260     * TODO: Model Documentation for
261     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.populatorType
262     * @return String
263     */
264    public String getPopulatorType();
265
266    /**
267     * Represents a role a user may play within a system.  Provides access to things such as
268     * services and
269     * service operations.
270     * @return Collection<Role>
271     */
272    public Collection<Role> getRoles();
273
274    /**
275     * Full path of this manageable search filter.
276     * @return String
277     */
278    public String getSearchFilterFullPath();
279
280    /**
281     * Search filter class name.
282     * @return String
283     */
284    public String getSearchFilterName();
285
286    /**
287     * The calculated serial version UID for this controller.
288     * @return String
289     */
290    public String getSearchFilterSerialVersionUID();
291
292    /**
293     * TODO: Model Documentation for
294     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.searchFormBeanClassName
295     * @return String
296     */
297    public String getSearchFormBeanClassName();
298
299    /**
300     * TODO: Model Documentation for
301     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.searchFormBeanFullPath
302     * @return String
303     */
304    public String getSearchFormBeanFullPath();
305
306    /**
307     * TODO: Model Documentation for
308     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.searchFormBeanName
309     * @return String
310     */
311    public String getSearchFormBeanName();
312
313    /**
314     * TODO: Model Documentation for
315     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.searchFormBeanType
316     * @return String
317     */
318    public String getSearchFormBeanType();
319
320    /**
321     * Tthe available types of export in a single String instance.
322     * @return String
323     */
324    public String getTableExportTypes();
325
326    /**
327     * The maximum number of rows to be displayed in the table at the same time. This is also known
328     * as the page size. A value of zero or less will display all data in the same table (therefore
329     * also on the same page).
330     * @return int
331     */
332    public int getTableMaxRows();
333
334    /**
335     * TODO: Model Documentation for
336     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.valueObjectClassName
337     * @return String
338     */
339    public String getValueObjectClassName();
340
341    /**
342     * TODO: Model Documentation for
343     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.viewFullPath
344     * @return String
345     */
346    public String getViewFullPath();
347
348    /**
349     * TODO: Model Documentation for
350     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.viewName
351     * @return String
352     */
353    public String getViewName();
354
355    /**
356     * TODO: Model Documentation for
357     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.viewTitleKey
358     * @return String
359     */
360    public String getViewTitleKey();
361
362    /**
363     * TODO: Model Documentation for
364     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.viewTitleValue
365     * @return String
366     */
367    public String getViewTitleValue();
368
369    /**
370     * TODO: Model Documentation for
371     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.needsFileUpload
372     * @return boolean
373     */
374    public boolean isNeedsFileUpload();
375
376    /**
377     * Returns true if the user needs to modify the standard behavior and a Impl.java file will be
378     * created in web/src/main/java.
379     * @return boolean
380     */
381    public boolean isNeedsImplementation();
382
383    /**
384     * TODO: Model Documentation for
385     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.needsUserInterface
386     * @return boolean
387     */
388    public boolean isNeedsUserInterface();
389
390    /**
391     * TODO: Model Documentation for
392     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.preload
393     * @return boolean
394     */
395    public boolean isPreload();
396
397    /**
398     * TODO: Model Documentation for
399     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.isSearchable
400     * @param element Object
401     * @return boolean
402     */
403    public boolean isSearchable(Object element);
404
405    /**
406     * True if it is possible to export the table data to XML, CSV, PDF or Excel format.
407     * @return boolean
408     */
409    public boolean isTableExportable();
410
411    /**
412     * True if it is possible to sort the columns of the table.
413     * @return boolean
414     */
415    public boolean isTableSortable();
416
417    /**
418     * TODO: Model Documentation for
419     * org.andromda.cartridges.jsf2.metafacades.JSFManageableEntity.validationRequired
420     * @return boolean
421     */
422    public boolean isValidationRequired();
423}