001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.bpm4struts.metafacades;
006
007import org.andromda.metafacades.uml.ManageableEntity;
008
009/**
010 * TODO: Model Documentation for
011 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity
012 *
013 * Metafacade interface to be used by AndroMDA cartridges.
014 */
015public interface StrutsManageableEntity
016    extends ManageableEntity
017{
018    /**
019     * Indicates the metafacade type (used for metafacade mappings).
020     *
021     * @return boolean always <code>true</code>
022     */
023    public boolean isStrutsManageableEntityMetaType();
024
025    /**
026     * TODO: Model Documentation for
027     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionClassName
028     * @return String
029     */
030    public String getActionClassName();
031
032    /**
033     * TODO: Model Documentation for
034     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionFullPath
035     * @return String
036     */
037    public String getActionFullPath();
038
039    /**
040     * TODO: Model Documentation for
041     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionParameter
042     * @return String
043     */
044    public String getActionParameter();
045
046    /**
047     * TODO: Model Documentation for
048     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionPath
049     * @return String
050     */
051    public String getActionPath();
052
053    /**
054     * TODO: Model Documentation for
055     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.actionType
056     * @return String
057     */
058    public String getActionType();
059
060    /**
061     * TODO: Model Documentation for
062     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.exceptionKey
063     * @return String
064     */
065    public String getExceptionKey();
066
067    /**
068     * TODO: Model Documentation for
069     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.exceptionPath
070     * @return String
071     */
072    public String getExceptionPath();
073
074    /**
075     * TODO: Model Documentation for
076     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanClassName
077     * @return String
078     */
079    public String getFormBeanClassName();
080
081    /**
082     * TODO: Model Documentation for
083     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanFullPath
084     * @return String
085     */
086    public String getFormBeanFullPath();
087
088    /**
089     * TODO: Model Documentation for
090     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanName
091     * @return String
092     */
093    public String getFormBeanName();
094
095    /**
096     * TODO: Model Documentation for
097     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntity.formBeanType
098     * @return String
099     */
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}