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.ManageableEntityAttribute;
008
009/**
010 * TODO: Model Documentation for
011 * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntityAttribute
012 *
013 * Metafacade interface to be used by AndroMDA cartridges.
014 */
015public interface StrutsManageableEntityAttribute
016    extends ManageableEntityAttribute
017{
018    /**
019     * Indicates the metafacade type (used for metafacade mappings).
020     *
021     * @return boolean always <code>true</code>
022     */
023    public boolean isStrutsManageableEntityAttributeMetaType();
024
025    /**
026     * The String format to use when referring to this date, only makes sense when the type is a
027     * date type.
028     * @return String
029     */
030    public String getDateFormat();
031
032    /**
033     * The number of columns for this field, null if default browser value is desired.
034     * @return Integer
035     */
036    public Integer getFieldColumnCount();
037
038    /**
039     * The number of rows for this field, null if default browser value is desired.
040     * @return Integer
041     */
042    public Integer getFieldRowCount();
043
044    /**
045     * TODO: Model Documentation for
046     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntityAttribute.messageKey
047     * @return String
048     */
049    public String getMessageKey();
050
051    /**
052     * TODO: Model Documentation for
053     * org.andromda.cartridges.bpm4struts.metafacades.StrutsManageableEntityAttribute.messageValue
054     * @return String
055     */
056    public String getMessageValue();
057
058    /**
059     * The key to lookup the online help documentation. This documentation is gathered from the
060     * documentation entered by the user, as well as analyzing the model.
061     * @return String
062     */
063    public String getOnlineHelpKey();
064
065    /**
066     * The online help documentation. This documentation is gathered from the documentation entered
067     * by the user, as well as analyzing the model. The format is HTML without any style.
068     * @return String
069     */
070    public String getOnlineHelpValue();
071
072    /**
073     * The widget to use when rendering this attribute
074     * @return String
075     */
076    public String getWidgetType();
077
078    /**
079     * Whether or not this attribute should be hidden from the view
080     * @return boolean
081     */
082    public boolean isHidden();
083
084    /**
085     * True if this attribute is of a type that cannot easily be represented as a textual string and
086     * would be an ideal candidate for HTTP's support for file-upload.
087     * @return boolean
088     */
089    public boolean isNeedsFileUpload();
090
091    /**
092     * True if this parameter has a name that can properly be handled by Jakarta commons (this lib
093     * is used by Struts but contains a bug)
094     * @return boolean
095     */
096    public boolean isSafeNamePresent();
097
098    /**
099     * True if this field is a date type and the date format is not be interpreted strictly.
100     * @return boolean
101     */
102    public boolean isStrictDateFormat();
103}