001// license-header java merge-point
002//
003// Attention: generated code (by Metafacade.vsl) - do not modify!
004//
005package org.andromda.metafacades.uml;
006
007import java.util.List;
008
009/**
010 * A front end forward is any transition between front-end states.
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface FrontEndForward
015    extends TransitionFacade
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isFrontEndForwardMetaType();
023
024    /**
025     * The method name used to delegate to this forward.
026     * @return String
027     */
028    public String getActionMethodName();
029
030    /**
031     * The front-end actions directly containing this front-end forward.
032     * @return List<FrontEndAction>
033     */
034    public List<FrontEndAction> getActions();
035
036    /**
037     * The trigger for this front-end forward.
038     * @return FrontEndEvent
039     */
040    public FrontEndEvent getDecisionTrigger();
041
042    /**
043     * Tthe set of parameter used during transport in this forward.
044     * @return List<FrontEndParameter>
045     */
046    public List<FrontEndParameter> getForwardParameters();
047
048    /**
049     * The activity graph which holds this forward if the graph is contained in a FrontEndUseCase.
050     * @return FrontEndActivityGraph
051     */
052    public FrontEndActivityGraph getFrontEndActivityGraph();
053
054    /**
055     * The operation to which is called during execution of this front-end forward.
056     * @return FrontEndControllerOperation
057     */
058    public FrontEndControllerOperation getOperationCall();
059
060    /**
061     * The use case in which this forward is contained.
062     * @return FrontEndUseCase
063     */
064    public FrontEndUseCase getUseCase();
065
066    /**
067     * Indicates if this forward is contained in a FrontEndUseCase.
068     * @return boolean
069     */
070    public boolean isContainedInFrontEndUseCase();
071
072    /**
073     * Indicates if this action directly targets a "front-end" view, false otherwise.
074     * @return boolean
075     */
076    public boolean isEnteringView();
077
078    /**
079     * Indicates if this forward (transition) is coming out of a front-end view.
080     * @return boolean
081     */
082    public boolean isExitingView();
083}