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 * Represents a view within a front end application.
011 *
012 * Metafacade interface to be used by AndroMDA cartridges.
013 */
014public interface FrontEndView
015    extends FrontEndActionState
016{
017    /**
018     * Indicates the metafacade type (used for metafacade mappings).
019     *
020     * @return boolean always <code>true</code>
021     */
022    public boolean isFrontEndViewMetaType();
023
024    /**
025     * All actions that can be triggered on this view.
026     * @return List<FrontEndAction>
027     */
028    public List<FrontEndAction> getActions();
029
030    /**
031     * All parameters for each action going out of this view.
032     * @return List<FrontEndParameter>
033     */
034    public List<FrontEndParameter> getAllActionParameters();
035
036    /**
037     * All fields from all forms on the given view.
038     * @return List<FrontEndParameter>
039     */
040    public List<FrontEndParameter> getAllFormFields();
041
042    /**
043     * All tables belonging to the front end view.
044     * @return List<FrontEndParameter>
045     */
046    public List<FrontEndParameter> getTables();
047
048    /**
049     * The use-case of which this view is a member.
050     * @return FrontEndUseCase
051     */
052    public FrontEndUseCase getUseCase();
053
054    /**
055     * All those variables that will be present as variables in the target view. These are the
056     * trigger parameters on the incoming transitions.
057     * @return List<FrontEndParameter>
058     */
059    public List<FrontEndParameter> getVariables();
060
061    /**
062     * True if this element carries the FrontEndView stereotype.
063     * @return boolean
064     */
065    public boolean isFrontEndView();
066}