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