1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.spring.metafacades;
6
7 import org.andromda.metafacades.uml.ServiceOperation;
8
9 /**
10 * Represents an operation for a SpringService.
11 *
12 * Metafacade interface to be used by AndroMDA cartridges.
13 */
14 public interface SpringServiceOperation
15 extends ServiceOperation
16 {
17 /**
18 * Indicates the metafacade type (used for metafacade mappings).
19 *
20 * @return boolean always <code>true</code>
21 */
22 public boolean isSpringServiceOperationMetaType();
23
24 /**
25 * The transaction type for EJB service operations (this is used when Session EJBs wrap the
26 * spring services).
27 * @return String
28 */
29 public String getEjbTransactionType();
30
31 /**
32 * The fully qualified name of the listener that accepts incoming messages for this operation.
33 * @return String
34 */
35 public String getFullyQualifiedMessageListenerName();
36
37 /**
38 * The method call for the implementation operation.
39 * @return String
40 */
41 public String getImplementationCall();
42
43 /**
44 * The name of the the operation used within the service implementation.
45 * @return String
46 */
47 public String getImplementationName();
48
49 /**
50 * The fully qualified name of the implementation return type.
51 * @return String
52 */
53 public String getImplementationReturnTypeName();
54
55 /**
56 * The signature for the implementation operation.
57 * @return String
58 */
59 public String getImplementationSignature();
60
61 /**
62 * The incoming JMS method implementation call.
63 * @return String
64 */
65 public String getIncomingMessageImplementationCall();
66
67 /**
68 * The incoming JMS implementation method signature.
69 * @return String
70 */
71 public String getIncomingMessageImplementationSignature();
72
73 /**
74 * The bean name of the message listener.
75 * @return String
76 */
77 public String getMessageListenerBeanName();
78
79 /**
80 * The bean name of the message listener container.
81 * @return String
82 */
83 public String getMessageListenerContainerBeanName();
84
85 /**
86 * The bean name for the message listener container reference.
87 * @return String
88 */
89 public String getMessageListenerContainerReferenceName();
90
91 /**
92 * Returns the name of the listener that accepts incoming messages for this operation.
93 * @return String
94 */
95 public String getMessageListenerName();
96
97 /**
98 * The outgoing JMS method implementation call.
99 * @return String
100 */
101 public String getOutgoingMessageImplementationCall();
102
103 /**
104 * The outgoing JMS implementation method signature.
105 * @return String
106 */
107 public String getOutgoingMessageImplementationSignature();
108
109 /**
110 * Indicates the "session acknowledge mode" for the JMS session when this operation acts as a
111 * message receiver from the messaging destination (aka JMS topic/queue).
112 * @return String
113 */
114 public String getSessionAcknowledgeMode();
115
116 /**
117 * Gets the throws clause for this service or null if the operation doesn't have any exceptions.
118 * @return String
119 */
120 public String getThrowsClause();
121
122 /**
123 * Retrieves the throws clause allowing a comma separated list of exceptions to be passed in and
124 * appended to the list.
125 * @param initialExceptions String
126 * @return String
127 */
128 public String getThrowsClause(String initialExceptions);
129
130 /**
131 * Stores the Spring transaction type for an operation.
132 * @return String
133 */
134 public String getTransactionType();
135
136 /**
137 * Returns true/false depending on whether or not this SpringServiceOperation should be an
138 * destroy-method
139 * @return boolean
140 */
141 public boolean isDestroyMethod();
142
143 /**
144 * Returns true/false depending on whether or not this SpringServiceOperation should be an
145 * init-method
146 * @return boolean
147 */
148 public boolean isInitMethod();
149
150 /**
151 * This flag tells if the MessageConverter associated to the MessageListenerAdapter handling
152 * incoming message should be set to null.
153 * @return boolean
154 */
155 public boolean isNullMessageConverterRequired();
156
157 /**
158 * Tthis flag includes whether or not the "optimizeAcknowledge" is true/false for a messaging
159 * destination (aka JMS topic/queue); when receiving a message through an ActiveMQ connection,
160 * @return boolean
161 */
162 public boolean isOptimizeAcknowledge();
163
164 /**
165 * Returns true/false depending on whether or not this SpringServiceOperation should be exposed
166 * in a webservice.
167 * @return boolean
168 */
169 public boolean isWebserviceExposed();
170 }