1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.bpm4struts.metafacades;
6
7 import org.andromda.metafacades.uml.ManageableEntity;
8
9 /**
10 * TODO: Model Documentation for
11 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity
12 *
13 * Metafacade interface to be used by AndroMDA cartridges.
14 */
15 public interface StrutsManageableEntity
16 extends ManageableEntity
17 {
18 /**
19 * Indicates the metafacade type (used for metafacade mappings).
20 *
21 * @return boolean always <code>true</code>
22 */
23 public boolean isStrutsManageableEntityMetaType();
24
25 /**
26 * TODO: Model Documentation for
27 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionClassName
28 * @return String
29 */
30 public String getActionClassName();
31
32 /**
33 * TODO: Model Documentation for
34 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionFullPath
35 * @return String
36 */
37 public String getActionFullPath();
38
39 /**
40 * TODO: Model Documentation for
41 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionParameter
42 * @return String
43 */
44 public String getActionParameter();
45
46 /**
47 * TODO: Model Documentation for
48 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionPath
49 * @return String
50 */
51 public String getActionPath();
52
53 /**
54 * TODO: Model Documentation for
55 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionType
56 * @return String
57 */
58 public String getActionType();
59
60 /**
61 * TODO: Model Documentation for
62 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.exceptionKey
63 * @return String
64 */
65 public String getExceptionKey();
66
67 /**
68 * TODO: Model Documentation for
69 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.exceptionPath
70 * @return String
71 */
72 public String getExceptionPath();
73
74 /**
75 * TODO: Model Documentation for
76 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanClassName
77 * @return String
78 */
79 public String getFormBeanClassName();
80
81 /**
82 * TODO: Model Documentation for
83 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanFullPath
84 * @return String
85 */
86 public String getFormBeanFullPath();
87
88 /**
89 * TODO: Model Documentation for
90 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanName
91 * @return String
92 */
93 public String getFormBeanName();
94
95 /**
96 * TODO: Model Documentation for
97 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanType
98 * @return String
99 */
100 public String getFormBeanType();
101
102 /**
103 * TODO: Model Documentation for
104 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.listGetterName
105 * @return String
106 */
107 public String getListGetterName();
108
109 /**
110 * TODO: Model Documentation for
111 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.listName
112 * @return String
113 */
114 public String getListName();
115
116 /**
117 * TODO: Model Documentation for
118 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.listSetterName
119 * @return String
120 */
121 public String getListSetterName();
122
123 /**
124 * TODO: Model Documentation for
125 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.messageKey
126 * @return String
127 */
128 public String getMessageKey();
129
130 /**
131 * TODO: Model Documentation for
132 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.messageValue
133 * @return String
134 */
135 public String getMessageValue();
136
137 /**
138 * The full path to this entity's online help action. The returned String does not have a suffix
139 * such as '.do'.
140 * @return String
141 */
142 public String getOnlineHelpActionPath();
143
144 /**
145 * The key to lookup the online help documentation.
146 * @return String
147 */
148 public String getOnlineHelpKey();
149
150 /**
151 * The full path to this entitiy's online help page. The returned String does not have a suffix
152 * such as '.jsp'.
153 * @return String
154 */
155 public String getOnlineHelpPagePath();
156
157 /**
158 * The online help documentation. The format is HTML without any style.
159 * @return String
160 */
161 public String getOnlineHelpValue();
162
163 /**
164 * TODO: Model Documentation for
165 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.pageFullPath
166 * @return String
167 */
168 public String getPageFullPath();
169
170 /**
171 * TODO: Model Documentation for
172 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.pageName
173 * @return String
174 */
175 public String getPageName();
176
177 /**
178 * TODO: Model Documentation for
179 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.pageTitleKey
180 * @return String
181 */
182 public String getPageTitleKey();
183
184 /**
185 * TODO: Model Documentation for
186 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.pageTitleValue
187 * @return String
188 */
189 public String getPageTitleValue();
190
191 /**
192 * Tthe available types of export in a single String instance.
193 * @return String
194 */
195 public String getTableExportTypes();
196
197 /**
198 * The maximum number of rows to be displayed in the table at the same time. This is also known
199 * as the page size. A value of zero or less will display all data in the same table (therefore
200 * also on the same page).
201 * @return int
202 */
203 public int getTableMaxRows();
204
205 /**
206 * True is this action is supposed to be rendered as enctype="multipart/form-data" on the page
207 * form.
208 * @return boolean
209 */
210 public boolean isMultipartFormData();
211
212 /**
213 * TODO: Model Documentation for
214 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.preload
215 * @return boolean
216 */
217 public boolean isPreload();
218
219 /**
220 * True if it is possible to export the table data to XML, CSV, PDF or Excel format.
221 * @return boolean
222 */
223 public boolean isTableExportable();
224
225 /**
226 * True if it is possible to sort the columns of the table.
227 * @return boolean
228 */
229 public boolean isTableSortable();
230 }