1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.ejb3.metafacades;
6
7 import org.andromda.metafacades.uml.AttributeFacade;
8
9 /**
10 * TODO: Model Documentation for org.andromda.cartridges.ejb3.metafacades.EJB3SessionAttributeFacade
11 *
12 * Metafacade interface to be used by AndroMDA cartridges.
13 */
14 public interface EJB3SessionAttributeFacade
15 extends AttributeFacade
16 {
17 /**
18 * Indicates the metafacade type (used for metafacade mappings).
19 *
20 * @return boolean always <code>true</code>
21 */
22 public boolean isEJB3SessionAttributeFacadeMetaType();
23
24 /**
25 * Returns a parameter string for org.jboss.seam.annotations.In annotation. Supported
26 * parameters:
27 * * value specifies the name of the context variable. Default to the name of the component
28 * attribute. Alternatively, specifies a JSF EL expression, surrounded by #{...}.
29 * * create specifies that Seam should instantiate the component with the same name as the
30 * context variable if the context variable is undefined (null) in all contexts. Default to
31 * false.
32 * * required specifies Seam should throw an exception if the context variable is undefined in
33 * all contexts.
34 * @return String
35 */
36 public String getSeamBijectionInParameters();
37
38 /**
39 * Returns a parameter string for org.jboss.seam.annotations.Logger annotation. Supported
40 * parameters:
41 * value specifies the name of the log category. Default to the name of the component class.
42 * @return String
43 */
44 public String getSeamBijectionLoggerParameters();
45
46 /**
47 * Returns a parameter string for org.jboss.seam.annotations.Out annotation. Supported
48 * parameters:
49 * * value specifies the name of the context variable. Default to the name of the component
50 * attribute.
51 * * required specifies Seam should throw an exception if the component attribute is null
52 * during outjection.
53 * * scope specifies the scope that Seam should bind the returned value to.
54 * @return String
55 */
56 public String getSeamBijectionOutParameters();
57
58 /**
59 * Returns a parameter string for org.jboss.seam.annotations.RequestParameter annotation.
60 * Supported parameters:
61 * * value specifies the name of the request parameter. Default to the name of the component
62 * attribute.
63 * @return String
64 */
65 public String getSeamBijectionRequestParameterParameters();
66
67 /**
68 * Returns a parameter string for org.jboss.seam.annotations.DataModel annotation. Supported
69 * parameters:
70 * * value name of the conversation context variable. Default to the attribute name.
71 * * scope if scope=ScopeType.PAGE is explicitly specified, the DataModel will be kept in the
72 * PAGE context.
73 * @return String
74 */
75 public String getSeamDataModelParameters();
76
77 /**
78 * Returns a parameter string for org.jboss.seam.annotations.DataModelSelection annotation.
79 * Supported parameters:
80 * * value name of the conversation context variable. Not needed if there is exactly one
81 * DataModel in the component.
82 * @return String
83 */
84 public String getSeamDataModelSelectionIndexParameters();
85
86 /**
87 * Returns a parameter string for org.jboss.seam.annotations.DataModelSelection annotation.
88 * Supported parameters:
89 * * value name of the conversation context variable. Not needed if there is exactly one
90 * DataModel in the component.
91 * @return String
92 */
93 public String getSeamDataModelSelectionParameters();
94
95 /**
96 * Gets the transaction type for this attribute (i.e. REQUIRED, etc)
97 * @return String
98 */
99 public String getTransactionType();
100
101 /**
102 * Returns true if this attribute is a seam component attribute, marked with one or more of the
103 * following annotations In, Out, Log, RequestParameter, DataModel, DatamodeSelection
104 * @return boolean
105 */
106 public boolean isSeamAttribute();
107
108 /**
109 * Returns true the attribute is modelled with the <<In>> stereotype indicating that it is a
110 * Seam component attribute and is to be injected from a context variable at the start of each
111 * component invocation.
112 * @return boolean
113 */
114 public boolean isSeamBijectionIn();
115
116 /**
117 * Returns true if stereotype <<Logger>> is set. Specifies that a component field is to be
118 * injected with an instance of org.jboss.seam.log.Log.
119 * @return boolean
120 */
121 public boolean isSeamBijectionLogger();
122
123 /**
124 * Returns true if the attribute is modelled with the <<Out>> stereotype indicating that it is a
125 * Seam component attribute and is to be outjected to a context variable at the end of each
126 * component invocation.
127 * @return boolean
128 */
129 public boolean isSeamBijectionOut();
130
131 /**
132 * Returns true if stereotype <<RequestParameter>> is set. Specifies that a component attribute
133 * is to be injected with the value of a request parameter. Basic type conversions are performed
134 * automatically.
135 * @return boolean
136 */
137 public boolean isSeamBijectionRequestParameter();
138
139 /**
140 * Returns true if the attribute of type List, Map, Set or Object[] is modelled with the
141 * <<DataModel>> stereotype indicating that it shall be exposed as a JSF DataModel into the
142 * scope of the owning component (or the EVENT scope if the owning component is STATELESS). In
143 * the case of Map, each row of the DataModel is a Map.Entry.
144 * @return boolean
145 */
146 public boolean isSeamDataModel();
147
148 /**
149 * Returns true if stereotype <<DataModelSelection>> is set. Injects the selected value from the
150 * JSF DataModel (this is the element of the underlying collection, or the map value).
151 * @return boolean
152 */
153 public boolean isSeamDataModelSelection();
154
155 /**
156 * Returns true if stereotype <<DataModelSelectionIndex>> is set. Exposes the selection index of
157 * the JSF DataModel as an attribute of the component (this is the row number of the underlying
158 * collection, or the map key).
159 * @return boolean
160 */
161 public boolean isSeamDataModelSelectionIndex();
162
163 /**
164 * Returns true if the <<Valid>> stereotype is modelled on seam component bean attribute to
165 * Indicates that the hibernate Validator recursively validate this and related objects when an
166 * action listener Seam component method with IfInvalid annotation is invoked.
167 * @return boolean
168 */
169 public boolean isSeamValidationValid();
170 }