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.List; 8 import org.andromda.metafacades.uml.FrontEndView; 9 10 /** 11 * A Struts JSP represents a page in the web application. A page possibly contains several forms and 12 * triggers (either buttons or hyperlinks) that call actions. 13 * 14 * Metafacade interface to be used by AndroMDA cartridges. 15 */ 16 public interface StrutsJsp 17 extends StrutsActionState, FrontEndView 18 { 19 /** 20 * Indicates the metafacade type (used for metafacade mappings). 21 * 22 * @return boolean always <code>true</code> 23 */ 24 public boolean isStrutsJspMetaType(); 25 26 /** 27 * The name of the file containing specific styles for this page only. 28 * @return String 29 */ 30 public String getCssFileName(); 31 32 /** 33 * A resource message key suited for the page's documentation. 34 * @return String 35 */ 36 public String getDocumentationKey(); 37 38 /** 39 * A resource message value suited for the page's documentation. 40 * @return String 41 */ 42 public String getDocumentationValue(); 43 44 /** 45 * The full path to this JSP page. the returned String does not have a suffix such as '.jsp'. 46 * @return String 47 */ 48 public String getFullPath(); 49 50 /** 51 * Returns all actions that possibly result in returning this page. 52 * @return List<StrutsAction> 53 */ 54 public List<StrutsAction> getIncomingActions(); 55 56 /** 57 * The default resource message key. 58 * @return String 59 */ 60 public String getMessageKey(); 61 62 /** 63 * A displayable version of this page's name. 64 * @return String 65 */ 66 public String getMessageValue(); 67 68 /** 69 * The collection of outgoing forwards that are not actions. 70 * @return List<StrutsForward> 71 */ 72 public List<StrutsForward> getNonActionForwards(); 73 74 /** 75 * The full path to this JSP's online help action. The returned String does not have a suffix 76 * such as '.do'. 77 * @return String 78 */ 79 public String getOnlineHelpActionPath(); 80 81 /** 82 * The key to lookup the online help documentation. This documentation is gathered from the 83 * documentation entered by the user, as well as analyzing the model. 84 * @return String 85 */ 86 public String getOnlineHelpKey(); 87 88 /** 89 * The full path to this JSP's online help page. The returned String does not have a suffix such 90 * as '.jsp'. 91 * @return String 92 */ 93 public String getOnlineHelpPagePath(); 94 95 /** 96 * The online help documentation. This documentation is gathered from the documentation entered 97 * by the user, as well as analyzing the model. The format is HTML without any style. 98 * @return String 99 */ 100 public String getOnlineHelpValue(); 101 102 /** 103 * Returns all those variables that will be present as variables in the target page. These are 104 * the trigger parameters on the incoming transitions. 105 * @return List<StrutsParameter> 106 */ 107 public List<StrutsParameter> getPageVariables(); 108 109 /** 110 * A resource message key suited for the page's title. 111 * @return String 112 */ 113 public String getTitleKey(); 114 115 /** 116 * A default resource message value suited for the page's title. 117 * @return String 118 */ 119 public String getTitleValue(); 120 121 /** 122 * True if this JSP contains a date field which requires a calendar popup. 123 * @return boolean 124 */ 125 public boolean isCalendarRequired(); 126 127 /** 128 * True if any of the actions have a parameter of type Date. 129 * @return boolean 130 */ 131 public boolean isDateFieldPresent(); 132 133 /** 134 * True if at least one client/server parameter requires validation. 135 * @return boolean 136 */ 137 public boolean isValidationRequired(); 138 }