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 java.util.Map;
008import org.andromda.metafacades.uml.FrontEndForward;
009
010/**
011 * A Struts forward is any transition between states. Some of these forwards may end up as actual
012 * forwards in the Struts deployment descriptor.
013 *
014 * Metafacade interface to be used by AndroMDA cartridges.
015 */
016public interface StrutsForward
017    extends FrontEndForward
018{
019    /**
020     * Indicates the metafacade type (used for metafacade mappings).
021     *
022     * @return boolean always <code>true</code>
023     */
024    public boolean isStrutsForwardMetaType();
025
026    /**
027     * The name for this forward. This name is always lowercase and words are separated using dots,
028     * not unlike the convention for Java package names.
029     * @return String
030     */
031    public String getForwardName();
032
033    /**
034     * Returns the path targetted by this forward.
035     * @return String
036     */
037    public String getForwardPath();
038
039    /**
040     * If this forward is guarded (such as with decision points) this method return the name of that
041     * guard.
042     * @return String
043     */
044    public String getGuardName();
045
046    /**
047     * Returns the activity graph which holds this action if the graph is contained in a
048     * FrontEndUseCase.
049     * @return StrutsActivityGraph
050     */
051    public StrutsActivityGraph getStrutsActivityGraph();
052
053    /**
054     * A map of key=value pairs, one for each success message.
055     * @return Map
056     */
057    public Map getSuccessMessages();
058
059    /**
060     * The resource bundle key of the name for the target element. This method returns the key for
061     * the use-case or jsp page. If targetting anything else this method returns null.
062     * @return String
063     */
064    public String getTargetNameKey();
065
066    /**
067     * A map of key=value pairs, one for each warning message.
068     * @return Map
069     */
070    public Map getWarningMessages();
071
072    /**
073     * True if this action directly targets a JSP page, false otherwise.
074     * @return boolean
075     */
076    public boolean isEnteringPage();
077
078    /**
079     * Whether or not this forward (transition) is coming out of a page.
080     * @return boolean
081     */
082    public boolean isExitingPage();
083
084    /**
085     * TODO: Model Documentation for
086     * org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.successMessagesPresent
087     * @return boolean
088     */
089    public boolean isSuccessMessagesPresent();
090
091    /**
092     * TODO: Model Documentation for
093     * org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.warningMessagesPresent
094     * @return boolean
095     */
096    public boolean isWarningMessagesPresent();
097}