View Javadoc

1   //
2   // Attention: generated code (by Metafacade.vsl) - do not modify!
3   //
4   package org.andromda.metafacades.uml;
5   
6   /***
7    * <p>
8    * Represents a "front-end" action. An action is some action that
9    * is taken when a front-end even occurs.
10   * </p>
11   *
12   * Metafacade interface to be used by AndroMDA cartridges.
13   */
14  public interface FrontEndAction
15      extends org.andromda.metafacades.uml.FrontEndForward
16  {
17  
18      /***
19       * Indicates the metafacade type (used for metafacade mappings).
20       *
21       * @return always <code>true</code>
22       */
23      public boolean isFrontEndActionMetaType();
24  
25     /***
26      * <p>
27      * Finds the parameter on this action having the given name, if no
28      * parameter is found, null is returned instead.
29      * </p>
30      */
31      public org.andromda.metafacades.uml.ParameterFacade findParameter(java.lang.String name);
32  
33     /***
34      * <p>
35      * All action forwards for this foward. Each action forward either
36      * calls a view or another use-case (which is essentially an
37      * action).
38      * </p>
39      */
40      public java.util.List getActionForwards();
41  
42     /***
43      * <p>
44      * All action states visited by this action.
45      * </p>
46      */
47      public java.util.List getActionStates();
48  
49     /***
50      * <p>
51      * The controller that will handle the execution of this front-end
52      * action. This controller is set as the context of the activity
53      * graph (and therefore also of the use-case).
54      * </p>
55      */
56      public org.andromda.metafacades.uml.FrontEndController getController();
57  
58     /***
59      * <p>
60      * All the transitions coming out of decision points. These
61      * transitions should all carry guards.
62      * </p>
63      */
64      public java.util.List getDecisionTransitions();
65  
66     /***
67      * <p>
68      * The controller operations to which this action defers, the order
69      * is preserved.
70      * </p>
71      */
72      public java.util.List getDeferredOperations();
73  
74     /***
75      * <p>
76      * Form fields for this action. Form fields are those parameters
77      * that can be altered by the user on a corresponding view at
78      * runtime.
79      * </p>
80      */
81      public java.util.List getFormFields();
82  
83     /***
84      * <p>
85      * The view on which this action can be triggered.
86      * </p>
87      */
88      public org.andromda.metafacades.uml.FrontEndView getInput();
89  
90     /***
91      * <p>
92      * All parameters sent by this "front-end" action.
93      * </p>
94      */
95      public java.util.List getParameters();
96  
97     /***
98      * <p>
99      * All views that can be possibly targetted by triggering this
100     * action.
101     * </p>
102     */
103     public java.util.List getTargetViews();
104 
105    /***
106     * <p>
107     * All the transitions that make up this action, this directly maps
108     * onto the forwards.
109     * </p>
110     */
111     public java.util.List getTransitions();
112 
113    /***
114     * <p>
115     * Indicates if this action represents the beginning of the
116     * front-end use case or not.
117     * </p>
118     */
119     public boolean isUseCaseStart();
120 
121 }