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 use case used in the "front end" of an application.
9    * </p>
10   *
11   * Metafacade interface to be used by AndroMDA cartridges.
12   */
13  public interface FrontEndUseCase
14      extends org.andromda.metafacades.uml.UseCaseFacade
15  {
16  
17      /***
18       * Indicates the metafacade type (used for metafacade mappings).
19       *
20       * @return always <code>true</code>
21       */
22      public boolean isFrontEndUseCaseMetaType();
23  
24     /***
25      * <p>
26      * The actions for this use-case. This will include the initial
27      * action to start the use-case.
28      * </p>
29      */
30      public java.util.List getActions();
31  
32     /***
33      * <p>
34      * Returns the activity graph describing this use-case in more
35      * detail.
36      * </p>
37      */
38      public org.andromda.metafacades.uml.FrontEndActivityGraph getActivityGraph();
39  
40     /***
41      * <p>
42      * All roles that directly or indirectly related to any "front-end"
43      * use cases.
44      * </p>
45      */
46      public java.util.List getAllRoles();
47  
48     /***
49      * <p>
50      * Returns all struts use-cases in this "front end" application.
51      * </p>
52      */
53      public java.util.List getAllUseCases();
54  
55     /***
56      * <p>
57      * Returns the controller for this use-case.
58      * </p>
59      */
60      public org.andromda.metafacades.uml.FrontEndController getController();
61  
62     /***
63      * <p>
64      * The first view of this use case, this may actually return a view
65      * of another use case if the first is found by traveling through
66      * the final state.
67      * </p>
68      */
69      public org.andromda.metafacades.uml.FrontEndView getInitialView();
70  
71     /***
72      * <p>
73      * The final states linking to this use case
74      * </p>
75      */
76      public java.util.List getReferencingFinalStates();
77  
78     /***
79      * <p>
80      * Returns all roles that are directly and indirectly associated to
81      * this use-case.
82      * </p>
83      */
84      public java.util.List getRoles();
85  
86     /***
87      * <p>
88      * The variables for all views in this use-case. A parameter
89      * qualifies to be a variable when it explicitely and directly
90      * receives it via an action.
91      * </p>
92      */
93      public java.util.List getViewVariables();
94  
95     /***
96      * <p>
97      * All views that are part of this use case.
98      * </p>
99      */
100     public java.util.List getViews();
101 
102    /***
103     * <p>
104     * True if this use-case is the entry point to the front end.
105     * </p>
106     */
107     public boolean isEntryUseCase();
108 
109    /***
110     * <p>
111     * Indicates if this use case is "secured".  This is true when
112     * there is at least one role associated to it.
113     * </p>
114     */
115     public boolean isSecured();
116 
117 }