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.FrontEndEvent;
008
009/**
010 * A Struts trigger is represented by clicking a hyperlink or posting an action form.
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface StrutsTrigger
015    extends FrontEndEvent
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isStrutsTriggerMetaType();
023
024    /**
025     * The message key to use as a tooltip when the user is not allowed to use this trigger.
026     * @return String
027     */
028    public String getNotAllowedTitleKey();
029
030    /**
031     * The message value to use as a tooltip when the user is not allowed to use this trigger.
032     * @return String
033     */
034    public String getNotAllowedTitleValue();
035
036    /**
037     * The message key to use for reset button labels.
038     * @return String
039     */
040    public String getResetMessageKey();
041
042    /**
043     * The message value to use for reset button labels.
044     * @return String
045     */
046    public String getResetMessageValue();
047
048    /**
049     * Returns the message key to use as a tooltip when the user is not allowed to use reset the
050     * form behind this trigger.
051     * @return String
052     */
053    public String getResetNotAllowedTitleKey();
054
055    /**
056     * The message value to use as a tooltip when the user is not allowed to use reset the form
057     * behind this trigger.
058     * @return String
059     */
060    public String getResetNotAllowedTitleValue();
061
062    /**
063     * The message reset title key to use as a tooltip for this trigger's reset feature.
064     * @return String
065     */
066    public String getResetTitleKey();
067
068    /**
069     * The tooltip value for this trigger's reset feature.
070     * @return String
071     */
072    public String getResetTitleValue();
073
074    /**
075     * If isActionTrigger() returns true them this association points to the action to which the
076     * trigger has been associated.
077     * @return StrutsAction
078     */
079    public StrutsAction getStrutsAction();
080
081    /**
082     * The message title key to use as a tooltip for this trigger.
083     * @return String
084     */
085    public String getTitleKey();
086
087    /**
088     * The default resource message value  for this trigger's tooltip.
089     * @return String
090     */
091    public String getTitleValue();
092
093    /**
094     * The message reset key for this trigger.
095     * @return String
096     */
097    public String getTriggerKey();
098
099    /**
100     * The resource message value  for this trigger, this would be the button label or hyperlink
101     * name.
102     * @return String
103     */
104    public String getTriggerValue();
105
106    /**
107     * True if this trigger is modeled on an action transition. That means, the transition is coming
108     * out of an action state with the FrontEndView stereotype. False otherwise.
109     * @return boolean
110     */
111    public boolean isActionTrigger();
112}