View Javadoc
1   // license-header java merge-point
2   //
3   // Attention: generated code (by Metafacade.vsl) - do not modify!
4   //
5   package org.andromda.metafacades.uml;
6   
7   import java.util.List;
8   
9   /**
10   * A front end forward is any transition between front-end states.
11   *
12   * Metafacade interface to be used by AndroMDA cartridges.
13   */
14  public interface FrontEndForward
15      extends TransitionFacade
16  {
17      /**
18       * Indicates the metafacade type (used for metafacade mappings).
19       *
20       * @return boolean always <code>true</code>
21       */
22      public boolean isFrontEndForwardMetaType();
23  
24      /**
25       * The method name used to delegate to this forward.
26       * @return String
27       */
28      public String getActionMethodName();
29  
30      /**
31       * The front-end actions directly containing this front-end forward.
32       * @return List<FrontEndAction>
33       */
34      public List<FrontEndAction> getActions();
35  
36      /**
37       * The trigger for this front-end forward.
38       * @return FrontEndEvent
39       */
40      public FrontEndEvent getDecisionTrigger();
41  
42      /**
43       * Tthe set of parameter used during transport in this forward.
44       * @return List<FrontEndParameter>
45       */
46      public List<FrontEndParameter> getForwardParameters();
47  
48      /**
49       * The activity graph which holds this forward if the graph is contained in a FrontEndUseCase.
50       * @return FrontEndActivityGraph
51       */
52      public FrontEndActivityGraph getFrontEndActivityGraph();
53  
54      /**
55       * The operation to which is called during execution of this front-end forward.
56       * @return FrontEndControllerOperation
57       */
58      public FrontEndControllerOperation getOperationCall();
59  
60      /**
61       * The use case in which this forward is contained.
62       * @return FrontEndUseCase
63       */
64      public FrontEndUseCase getUseCase();
65  
66      /**
67       * Indicates if this forward is contained in a FrontEndUseCase.
68       * @return boolean
69       */
70      public boolean isContainedInFrontEndUseCase();
71  
72      /**
73       * Indicates if this action directly targets a "front-end" view, false otherwise.
74       * @return boolean
75       */
76      public boolean isEnteringView();
77  
78      /**
79       * Indicates if this forward (transition) is coming out of a front-end view.
80       * @return boolean
81       */
82      public boolean isExitingView();
83  }