View Javadoc
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 org.andromda.metafacades.uml.FrontEndEvent;
8   
9   /**
10   * A Struts trigger is represented by clicking a hyperlink or posting an action form.
11   *
12   * Metafacade interface to be used by AndroMDA cartridges.
13   */
14  public interface StrutsTrigger
15      extends FrontEndEvent
16  {
17      /**
18       * Indicates the metafacade type (used for metafacade mappings).
19       *
20       * @return boolean always <code>true</code>
21       */
22      public boolean isStrutsTriggerMetaType();
23  
24      /**
25       * The message key to use as a tooltip when the user is not allowed to use this trigger.
26       * @return String
27       */
28      public String getNotAllowedTitleKey();
29  
30      /**
31       * The message value to use as a tooltip when the user is not allowed to use this trigger.
32       * @return String
33       */
34      public String getNotAllowedTitleValue();
35  
36      /**
37       * The message key to use for reset button labels.
38       * @return String
39       */
40      public String getResetMessageKey();
41  
42      /**
43       * The message value to use for reset button labels.
44       * @return String
45       */
46      public String getResetMessageValue();
47  
48      /**
49       * Returns the message key to use as a tooltip when the user is not allowed to use reset the
50       * form behind this trigger.
51       * @return String
52       */
53      public String getResetNotAllowedTitleKey();
54  
55      /**
56       * The message value to use as a tooltip when the user is not allowed to use reset the form
57       * behind this trigger.
58       * @return String
59       */
60      public String getResetNotAllowedTitleValue();
61  
62      /**
63       * The message reset title key to use as a tooltip for this trigger's reset feature.
64       * @return String
65       */
66      public String getResetTitleKey();
67  
68      /**
69       * The tooltip value for this trigger's reset feature.
70       * @return String
71       */
72      public String getResetTitleValue();
73  
74      /**
75       * If isActionTrigger() returns true them this association points to the action to which the
76       * trigger has been associated.
77       * @return StrutsAction
78       */
79      public StrutsAction getStrutsAction();
80  
81      /**
82       * The message title key to use as a tooltip for this trigger.
83       * @return String
84       */
85      public String getTitleKey();
86  
87      /**
88       * The default resource message value  for this trigger's tooltip.
89       * @return String
90       */
91      public String getTitleValue();
92  
93      /**
94       * The message reset key for this trigger.
95       * @return String
96       */
97      public String getTriggerKey();
98  
99      /**
100      * The resource message value  for this trigger, this would be the button label or hyperlink
101      * name.
102      * @return String
103      */
104     public String getTriggerValue();
105 
106     /**
107      * True if this trigger is modeled on an action transition. That means, the transition is coming
108      * out of an action state with the FrontEndView stereotype. False otherwise.
109      * @return boolean
110      */
111     public boolean isActionTrigger();
112 }