View Javadoc

1   //
2   // Attention: generated code (by Metafacade.vsl) - do not modify!
3   //
4   package org.andromda.cartridges.bpm4struts.metafacades;
5   
6   /***
7    * <p>
8    * A Struts forward is any transition between states. Some of these
9    * forwards may end up as actual forwards in the Struts deployment
10   * descriptor.
11   * </p>
12   *
13   * Metafacade interface to be used by AndroMDA cartridges.
14   */
15  public interface StrutsForward
16      extends org.andromda.metafacades.uml.FrontEndForward
17  {
18  
19      /***
20       * Indicates the metafacade type (used for metafacade mappings).
21       *
22       * @return always <code>true</code>
23       */
24      public boolean isStrutsForwardMetaType();
25  
26     /***
27      * <p>
28      * The name for this forward. This name is always lowercase and
29      * words are separated using dots, not unlike the convention for
30      * Java package names.
31      * </p>
32      */
33      public java.lang.String getForwardName();
34  
35     /***
36      * <p>
37      * Returns the path targetted by this forward.
38      * </p>
39      */
40      public java.lang.String getForwardPath();
41  
42     /***
43      * <p>
44      * If this forward is guarded (such as with decision points) this
45      * method return the name of that guard.
46      * </p>
47      */
48      public java.lang.String getGuardName();
49  
50     /***
51      * <p>
52      * Returns the activity graph which holds this action if the graph
53      * is contained in a FrontEndUseCase.
54      * </p>
55      */
56      public org.andromda.cartridges.bpm4struts.metafacades.StrutsActivityGraph getStrutsActivityGraph();
57  
58     /***
59      * <p>
60      * A map of key=value pairs, one for each success message.
61      * </p>
62      */
63      public java.util.Map getSuccessMessages();
64  
65     /***
66      * <p>
67      * The resource bundle key of the name for the target element. This
68      * method returns the key for the use-case or jsp page. If
69      * targetting anything else this method returns null.
70      * </p>
71      */
72      public java.lang.String getTargetNameKey();
73  
74     /***
75      * <p>
76      * A map of key=value pairs, one for each warning message.
77      * </p>
78      */
79      public java.util.Map getWarningMessages();
80  
81     /***
82      * <p>
83      * True if this action directly targets a JSP page, false
84      * otherwise.
85      * </p>
86      */
87      public boolean isEnteringPage();
88  
89     /***
90      * <p>
91      * Whether or not this forward (transition) is coming out of a
92      * page.
93      * </p>
94      */
95      public boolean isExitingPage();
96  
97     /***
98      * 
99      */
100     public boolean isSuccessMessagesPresent();
101 
102    /***
103     * 
104     */
105     public boolean isWarningMessagesPresent();
106 
107 }