001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.cartridges.jsf.metafacades;
006
007import java.util.Map;
008import org.andromda.metafacades.uml.FrontEndForward;
009
010/**
011 * Represents a forward within a JSF activity graph.
012 *
013 * Metafacade interface to be used by AndroMDA cartridges.
014 */
015public interface JSFForward
016    extends FrontEndForward
017{
018    /**
019     * Indicates the metafacade type (used for metafacade mappings).
020     *
021     * @return boolean always <code>true</code>
022     */
023    public boolean isJSFForwardMetaType();
024
025    /**
026     * The name that corresponds to the from-outcome in an navigational rule.
027     * @return String
028     */
029    public String getFromOutcome();
030
031    /**
032     * The path to which this forward points.
033     * @return String
034     */
035    public String getPath();
036
037    /**
038     * Messages used to indicate successful execution.
039     * @return Map
040     */
041    public Map getSuccessMessages();
042
043    /**
044     * Any messages used to indicate a warning.
045     * @return Map
046     */
047    public Map getWarningMessages();
048
049    /**
050     * Indicates whether or not a final state is the target of this forward.
051     * @return boolean
052     */
053    public boolean isFinalStateTarget();
054
055    /**
056     * Indicates whether or not any success messags are present.
057     * @return boolean
058     */
059    public boolean isSuccessMessagesPresent();
060
061    /**
062     * Whether or not any warning messages are present.
063     * @return boolean
064     */
065    public boolean isWarningMessagesPresent();
066}