source: branches/supervisor/doc/omq/common/message/Response.html

Last change on this file was 85, checked in by stoda, 11 years ago

Javadocs updated
File size: 12.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="es">
4<head>
5<!-- Generated by javadoc (version 1.7.0_25) on Wed Jul 10 13:13:18 CEST 2013 -->
6<title>Response</title>
7<meta name="date" content="2013-07-10">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="Response";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/Response.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../index-files/index-1.html">Index</a></li>
34<li><a href="../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../omq/common/message/Request.html" title="class in omq.common.message"><span class="strong">Prev Class</span></a></li>
40<li>Next Class</li>
41</ul>
42<ul class="navList">
43<li><a href="../../../index.html?omq/common/message/Response.html" target="_top">Frames</a></li>
44<li><a href="Response.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">omq.common.message</div>
83<h2 title="Class Response" class="title">Class Response</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li>java.lang.Object</li>
88<li>
89<ul class="inheritance">
90<li>omq.common.message.Response</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<dl>
98<dt>All Implemented Interfaces:</dt>
99<dd>java.io.Serializable</dd>
100</dl>
101<hr>
102<br>
103<pre>public class <span class="strong">Response</span>
104extends java.lang.Object
105implements java.io.Serializable</pre>
106<div class="block">Serializable response information. This class is used to send the information
107 to the client proxy. It has information about which remoteObject has invoked
108 the method and its correlation id. This class also has the result of the
109 invoke if everything has gone fine in the server or an error otherwise.</div>
110<dl><dt><span class="strong">Author:</span></dt>
111  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd>
112<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#omq.common.message.Response">Serialized Form</a></dd></dl>
113</li>
114</ul>
115</div>
116<div class="summary">
117<ul class="blockList">
118<li class="blockList">
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120<ul class="blockList">
121<li class="blockList"><a name="constructor_summary">
122<!--   -->
123</a>
124<h3>Constructor Summary</h3>
125<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
126<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
127<tr>
128<th class="colOne" scope="col">Constructor and Description</th>
129</tr>
130<tr class="altColor">
131<td class="colOne"><code><strong><a href="../../../omq/common/message/Response.html#Response()">Response</a></strong>()</code>&nbsp;</td>
132</tr>
133<tr class="rowColor">
134<td class="colOne"><code><strong><a href="../../../omq/common/message/Response.html#Response(java.lang.String, java.lang.String, java.lang.Object, omq.exception.OmqException)">Response</a></strong>(java.lang.String&nbsp;id,
135        java.lang.String&nbsp;idOmq,
136        java.lang.Object&nbsp;result,
137        <a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a>&nbsp;error)</code>
138<div class="block">Creates a new Response object to be serialized</div>
139</td>
140</tr>
141</table>
142</li>
143</ul>
144<!-- ========== METHOD SUMMARY =========== -->
145<ul class="blockList">
146<li class="blockList"><a name="method_summary">
147<!--   -->
148</a>
149<h3>Method Summary</h3>
150<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
151<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
152<tr>
153<th class="colFirst" scope="col">Modifier and Type</th>
154<th class="colLast" scope="col">Method and Description</th>
155</tr>
156<tr class="altColor">
157<td class="colFirst"><code><a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a></code></td>
158<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#getError()">getError</a></strong>()</code>&nbsp;</td>
159</tr>
160<tr class="rowColor">
161<td class="colFirst"><code>java.lang.String</code></td>
162<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#getId()">getId</a></strong>()</code>&nbsp;</td>
163</tr>
164<tr class="altColor">
165<td class="colFirst"><code>java.lang.String</code></td>
166<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#getIdOmq()">getIdOmq</a></strong>()</code>&nbsp;</td>
167</tr>
168<tr class="rowColor">
169<td class="colFirst"><code>java.lang.Object</code></td>
170<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#getResult()">getResult</a></strong>()</code>&nbsp;</td>
171</tr>
172<tr class="altColor">
173<td class="colFirst"><code>void</code></td>
174<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#setError(omq.exception.OmqException)">setError</a></strong>(<a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a>&nbsp;error)</code>&nbsp;</td>
175</tr>
176<tr class="rowColor">
177<td class="colFirst"><code>void</code></td>
178<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#setId(java.lang.String)">setId</a></strong>(java.lang.String&nbsp;id)</code>&nbsp;</td>
179</tr>
180<tr class="altColor">
181<td class="colFirst"><code>void</code></td>
182<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#setIdOmq(java.lang.String)">setIdOmq</a></strong>(java.lang.String&nbsp;idOmq)</code>&nbsp;</td>
183</tr>
184<tr class="rowColor">
185<td class="colFirst"><code>void</code></td>
186<td class="colLast"><code><strong><a href="../../../omq/common/message/Response.html#setResult(java.lang.Object)">setResult</a></strong>(java.lang.Object&nbsp;result)</code>&nbsp;</td>
187</tr>
188</table>
189<ul class="blockList">
190<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
191<!--   -->
192</a>
193<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
194<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
195</ul>
196</li>
197</ul>
198</li>
199</ul>
200</div>
201<div class="details">
202<ul class="blockList">
203<li class="blockList">
204<!-- ========= CONSTRUCTOR DETAIL ======== -->
205<ul class="blockList">
206<li class="blockList"><a name="constructor_detail">
207<!--   -->
208</a>
209<h3>Constructor Detail</h3>
210<a name="Response()">
211<!--   -->
212</a>
213<ul class="blockList">
214<li class="blockList">
215<h4>Response</h4>
216<pre>public&nbsp;Response()</pre>
217</li>
218</ul>
219<a name="Response(java.lang.String, java.lang.String, java.lang.Object, omq.exception.OmqException)">
220<!--   -->
221</a>
222<ul class="blockListLast">
223<li class="blockList">
224<h4>Response</h4>
225<pre>public&nbsp;Response(java.lang.String&nbsp;id,
226        java.lang.String&nbsp;idOmq,
227        java.lang.Object&nbsp;result,
228        <a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a>&nbsp;error)</pre>
229<div class="block">Creates a new Response object to be serialized</div>
230<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - - correlation id of the invoke</dd><dd><code>idOmq</code> - - objectmq's identifier -bind reference-</dd><dd><code>result</code> - - result of the invocation</dd><dd><code>error</code> - - error thrown by the invocation</dd></dl>
231</li>
232</ul>
233</li>
234</ul>
235<!-- ============ METHOD DETAIL ========== -->
236<ul class="blockList">
237<li class="blockList"><a name="method_detail">
238<!--   -->
239</a>
240<h3>Method Detail</h3>
241<a name="getId()">
242<!--   -->
243</a>
244<ul class="blockList">
245<li class="blockList">
246<h4>getId</h4>
247<pre>public&nbsp;java.lang.String&nbsp;getId()</pre>
248</li>
249</ul>
250<a name="setId(java.lang.String)">
251<!--   -->
252</a>
253<ul class="blockList">
254<li class="blockList">
255<h4>setId</h4>
256<pre>public&nbsp;void&nbsp;setId(java.lang.String&nbsp;id)</pre>
257</li>
258</ul>
259<a name="getIdOmq()">
260<!--   -->
261</a>
262<ul class="blockList">
263<li class="blockList">
264<h4>getIdOmq</h4>
265<pre>public&nbsp;java.lang.String&nbsp;getIdOmq()</pre>
266</li>
267</ul>
268<a name="setIdOmq(java.lang.String)">
269<!--   -->
270</a>
271<ul class="blockList">
272<li class="blockList">
273<h4>setIdOmq</h4>
274<pre>public&nbsp;void&nbsp;setIdOmq(java.lang.String&nbsp;idOmq)</pre>
275</li>
276</ul>
277<a name="getResult()">
278<!--   -->
279</a>
280<ul class="blockList">
281<li class="blockList">
282<h4>getResult</h4>
283<pre>public&nbsp;java.lang.Object&nbsp;getResult()</pre>
284</li>
285</ul>
286<a name="setResult(java.lang.Object)">
287<!--   -->
288</a>
289<ul class="blockList">
290<li class="blockList">
291<h4>setResult</h4>
292<pre>public&nbsp;void&nbsp;setResult(java.lang.Object&nbsp;result)</pre>
293</li>
294</ul>
295<a name="getError()">
296<!--   -->
297</a>
298<ul class="blockList">
299<li class="blockList">
300<h4>getError</h4>
301<pre>public&nbsp;<a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a>&nbsp;getError()</pre>
302</li>
303</ul>
304<a name="setError(omq.exception.OmqException)">
305<!--   -->
306</a>
307<ul class="blockListLast">
308<li class="blockList">
309<h4>setError</h4>
310<pre>public&nbsp;void&nbsp;setError(<a href="../../../omq/exception/OmqException.html" title="class in omq.exception">OmqException</a>&nbsp;error)</pre>
311</li>
312</ul>
313</li>
314</ul>
315</li>
316</ul>
317</div>
318</div>
319<!-- ========= END OF CLASS DATA ========= -->
320<!-- ======= START OF BOTTOM NAVBAR ====== -->
321<div class="bottomNav"><a name="navbar_bottom">
322<!--   -->
323</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
324<!--   -->
325</a>
326<ul class="navList" title="Navigation">
327<li><a href="../../../overview-summary.html">Overview</a></li>
328<li><a href="package-summary.html">Package</a></li>
329<li class="navBarCell1Rev">Class</li>
330<li><a href="class-use/Response.html">Use</a></li>
331<li><a href="package-tree.html">Tree</a></li>
332<li><a href="../../../deprecated-list.html">Deprecated</a></li>
333<li><a href="../../../index-files/index-1.html">Index</a></li>
334<li><a href="../../../help-doc.html">Help</a></li>
335</ul>
336</div>
337<div class="subNav">
338<ul class="navList">
339<li><a href="../../../omq/common/message/Request.html" title="class in omq.common.message"><span class="strong">Prev Class</span></a></li>
340<li>Next Class</li>
341</ul>
342<ul class="navList">
343<li><a href="../../../index.html?omq/common/message/Response.html" target="_top">Frames</a></li>
344<li><a href="Response.html" target="_top">No Frames</a></li>
345</ul>
346<ul class="navList" id="allclasses_navbar_bottom">
347<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
348</ul>
349<div>
350<script type="text/javascript"><!--
351  allClassesLink = document.getElementById("allclasses_navbar_bottom");
352  if(window==top) {
353    allClassesLink.style.display = "block";
354  }
355  else {
356    allClassesLink.style.display = "none";
357  }
358  //-->
359</script>
360</div>
361<div>
362<ul class="subNavList">
363<li>Summary:&nbsp;</li>
364<li>Nested&nbsp;|&nbsp;</li>
365<li>Field&nbsp;|&nbsp;</li>
366<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
367<li><a href="#method_summary">Method</a></li>
368</ul>
369<ul class="subNavList">
370<li>Detail:&nbsp;</li>
371<li>Field&nbsp;|&nbsp;</li>
372<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
373<li><a href="#method_detail">Method</a></li>
374</ul>
375</div>
376<a name="skip-navbar_bottom">
377<!--   -->
378</a></div>
379<!-- ======== END OF BOTTOM NAVBAR ======= -->
380</body>
381</html>
Note: See TracBrowser for help on using the repository browser.