source: javadoc/genius/core/repository/ParticipantRepItem.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 16.6 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="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:57 CEST 2018 -->
6<title>ParticipantRepItem (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="ParticipantRepItem (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":6,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":6};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/ParticipantRepItem.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/repository/ParticipantRepItem.html" target="_top">Frames</a></li>
57<li><a href="ParticipantRepItem.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.repository</div>
96<h2 title="Class ParticipantRepItem" class="title">Class ParticipantRepItem</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.repository.ParticipantRepItem</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd><a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a>, java.io.Serializable</dd>
113</dl>
114<dl>
115<dt>Direct Known Subclasses:</dt>
116<dd><a href="../../../genius/core/repository/boa/BoaPartyRepItem.html" title="class in genius.core.repository.boa">BoaPartyRepItem</a>, <a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository">PartyRepItem</a></dd>
117</dl>
118<hr>
119<br>
120<pre>public abstract class <span class="typeNameLabel">ParticipantRepItem</span>
121extends java.lang.Object
122implements <a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a></pre>
123<div class="block">Abstract superclass for RepItems that can generate Participants.</div>
124<dl>
125<dt><span class="seeLabel">See Also:</span></dt>
126<dd><a href="../../../serialized-form.html#genius.core.repository.ParticipantRepItem">Serialized Form</a></dd>
127</dl>
128</li>
129</ul>
130</div>
131<div class="summary">
132<ul class="blockList">
133<li class="blockList">
134<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135<ul class="blockList">
136<li class="blockList"><a name="constructor.summary">
137<!-- -->
138</a>
139<h3>Constructor Summary</h3>
140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
141<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
142<tr>
143<th class="colFirst" scope="col">Modifier</th>
144<th class="colLast" scope="col">Constructor and Description</th>
145</tr>
146<tr class="altColor">
147<td class="colFirst"><code>protected </code></td>
148<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#ParticipantRepItem--">ParticipantRepItem</a></span>()</code>&nbsp;</td>
149</tr>
150</table>
151</li>
152</ul>
153<!-- ========== METHOD SUMMARY =========== -->
154<ul class="blockList">
155<li class="blockList"><a name="method.summary">
156<!-- -->
157</a>
158<h3>Method Summary</h3>
159<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
160<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
161<tr>
162<th class="colFirst" scope="col">Modifier and Type</th>
163<th class="colLast" scope="col">Method and Description</th>
164</tr>
165<tr id="i0" class="altColor">
166<td class="colFirst"><code>abstract java.lang.String</code></td>
167<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#getClassDescriptor--">getClassDescriptor</a></span>()</code>&nbsp;</td>
168</tr>
169<tr id="i1" class="rowColor">
170<td class="colFirst"><code>java.lang.String</code></td>
171<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#getProtocolClassPath--">getProtocolClassPath</a></span>()</code>&nbsp;</td>
172</tr>
173<tr id="i2" class="altColor">
174<td class="colFirst"><code>abstract java.lang.String</code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#getUniqueName--">getUniqueName</a></span>()</code>&nbsp;</td>
176</tr>
177<tr id="i3" class="rowColor">
178<td class="colFirst"><code>int</code></td>
179<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
180</tr>
181<tr id="i4" class="altColor">
182<td class="colFirst"><code>protected <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#init--">init</a></span>()</code>
184<div class="block">Init our fields to cache the party information.</div>
185</td>
186</tr>
187<tr id="i5" class="rowColor">
188<td class="colFirst"><code>protected void</code></td>
189<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#initSilent--">initSilent</a></span>()</code>
190<div class="block">call init but suppress any exceptions and print just a stacktrace.</div>
191</td>
192</tr>
193<tr id="i6" class="altColor">
194<td class="colFirst"><code>java.lang.Boolean</code></td>
195<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#isMediator--">isMediator</a></span>()</code>&nbsp;</td>
196</tr>
197<tr id="i7" class="rowColor">
198<td class="colFirst"><code>abstract <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></td>
199<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/ParticipantRepItem.html#load--">load</a></span>()</code>&nbsp;</td>
200</tr>
201</table>
202<ul class="blockList">
203<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
204<!-- -->
205</a>
206<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
207<code>clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
208</ul>
209<ul class="blockList">
210<li class="blockList"><a name="methods.inherited.from.class.genius.core.repository.RepItem">
211<!-- -->
212</a>
213<h3>Methods inherited from interface&nbsp;genius.core.repository.<a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a></h3>
214<code><a href="../../../genius/core/repository/RepItem.html#getName--">getName</a></code></li>
215</ul>
216</li>
217</ul>
218</li>
219</ul>
220</div>
221<div class="details">
222<ul class="blockList">
223<li class="blockList">
224<!-- ========= CONSTRUCTOR DETAIL ======== -->
225<ul class="blockList">
226<li class="blockList"><a name="constructor.detail">
227<!-- -->
228</a>
229<h3>Constructor Detail</h3>
230<a name="ParticipantRepItem--">
231<!-- -->
232</a>
233<ul class="blockListLast">
234<li class="blockList">
235<h4>ParticipantRepItem</h4>
236<pre>protected&nbsp;ParticipantRepItem()</pre>
237</li>
238</ul>
239</li>
240</ul>
241<!-- ============ METHOD DETAIL ========== -->
242<ul class="blockList">
243<li class="blockList"><a name="method.detail">
244<!-- -->
245</a>
246<h3>Method Detail</h3>
247<a name="load--">
248<!-- -->
249</a>
250<ul class="blockList">
251<li class="blockList">
252<h4>load</h4>
253<pre>public abstract&nbsp;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;load()
254 throws <a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></pre>
255<dl>
256<dt><span class="returnLabel">Returns:</span></dt>
257<dd>the actual <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> that this refers to.</dd>
258<dt><span class="throwsLabel">Throws:</span></dt>
259<dd><code><a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></code> - if party can't be loaded</dd>
260</dl>
261</li>
262</ul>
263<a name="isMediator--">
264<!-- -->
265</a>
266<ul class="blockList">
267<li class="blockList">
268<h4>isMediator</h4>
269<pre>public&nbsp;java.lang.Boolean&nbsp;isMediator()</pre>
270</li>
271</ul>
272<a name="hashCode--">
273<!-- -->
274</a>
275<ul class="blockList">
276<li class="blockList">
277<h4>hashCode</h4>
278<pre>public&nbsp;int&nbsp;hashCode()</pre>
279<dl>
280<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
281<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
282</dl>
283</li>
284</ul>
285<a name="getUniqueName--">
286<!-- -->
287</a>
288<ul class="blockList">
289<li class="blockList">
290<h4>getUniqueName</h4>
291<pre>public abstract&nbsp;java.lang.String&nbsp;getUniqueName()</pre>
292<dl>
293<dt><span class="returnLabel">Returns:</span></dt>
294<dd>a unique name that identifies this participant. Used e.g. to
295 create a storage space. Can be derived from the class name or
296 other settings in the participant. Notice that <a href="../../../genius/core/repository/RepItem.html#getName--"><code>RepItem.getName()</code></a>
297 may not be unique.</dd>
298</dl>
299</li>
300</ul>
301<a name="getProtocolClassPath--">
302<!-- -->
303</a>
304<ul class="blockList">
305<li class="blockList">
306<h4>getProtocolClassPath</h4>
307<pre>public&nbsp;java.lang.String&nbsp;getProtocolClassPath()</pre>
308</li>
309</ul>
310<a name="init--">
311<!-- -->
312</a>
313<ul class="blockList">
314<li class="blockList">
315<h4>init</h4>
316<pre>protected&nbsp;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;init()
317 throws <a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></pre>
318<div class="block">Init our fields to cache the party information. party must have been set
319 before getting here.</div>
320<dl>
321<dt><span class="paramLabel">Parameters:</span></dt>
322<dd><code>party</code> - </dd>
323<dt><span class="throwsLabel">Throws:</span></dt>
324<dd><code><a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></code></dd>
325</dl>
326</li>
327</ul>
328<a name="initSilent--">
329<!-- -->
330</a>
331<ul class="blockList">
332<li class="blockList">
333<h4>initSilent</h4>
334<pre>protected final&nbsp;void&nbsp;initSilent()
335 throws <a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></pre>
336<div class="block">call init but suppress any exceptions and print just a stacktrace.</div>
337<dl>
338<dt><span class="throwsLabel">Throws:</span></dt>
339<dd><code><a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></code></dd>
340</dl>
341</li>
342</ul>
343<a name="getClassDescriptor--">
344<!-- -->
345</a>
346<ul class="blockListLast">
347<li class="blockList">
348<h4>getClassDescriptor</h4>
349<pre>public abstract&nbsp;java.lang.String&nbsp;getClassDescriptor()</pre>
350<dl>
351<dt><span class="returnLabel">Returns:</span></dt>
352<dd>a descriptor that is unique for this rep item class. Typically a
353 full.class.path but may be a composite.</dd>
354</dl>
355</li>
356</ul>
357</li>
358</ul>
359</li>
360</ul>
361</div>
362</div>
363<!-- ========= END OF CLASS DATA ========= -->
364<!-- ======= START OF BOTTOM NAVBAR ====== -->
365<div class="bottomNav"><a name="navbar.bottom">
366<!-- -->
367</a>
368<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
369<a name="navbar.bottom.firstrow">
370<!-- -->
371</a>
372<ul class="navList" title="Navigation">
373<li><a href="../../../overview-summary.html">Overview</a></li>
374<li><a href="package-summary.html">Package</a></li>
375<li class="navBarCell1Rev">Class</li>
376<li><a href="class-use/ParticipantRepItem.html">Use</a></li>
377<li><a href="package-tree.html">Tree</a></li>
378<li><a href="../../../deprecated-list.html">Deprecated</a></li>
379<li><a href="../../../index-all.html">Index</a></li>
380<li><a href="../../../help-doc.html">Help</a></li>
381</ul>
382</div>
383<div class="subNav">
384<ul class="navList">
385<li><a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
386<li><a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
387</ul>
388<ul class="navList">
389<li><a href="../../../index.html?genius/core/repository/ParticipantRepItem.html" target="_top">Frames</a></li>
390<li><a href="ParticipantRepItem.html" target="_top">No&nbsp;Frames</a></li>
391</ul>
392<ul class="navList" id="allclasses_navbar_bottom">
393<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
394</ul>
395<div>
396<script type="text/javascript"><!--
397 allClassesLink = document.getElementById("allclasses_navbar_bottom");
398 if(window==top) {
399 allClassesLink.style.display = "block";
400 }
401 else {
402 allClassesLink.style.display = "none";
403 }
404 //-->
405</script>
406</div>
407<div>
408<ul class="subNavList">
409<li>Summary:&nbsp;</li>
410<li>Nested&nbsp;|&nbsp;</li>
411<li>Field&nbsp;|&nbsp;</li>
412<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
413<li><a href="#method.summary">Method</a></li>
414</ul>
415<ul class="subNavList">
416<li>Detail:&nbsp;</li>
417<li>Field&nbsp;|&nbsp;</li>
418<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
419<li><a href="#method.detail">Method</a></li>
420</ul>
421</div>
422<a name="skip.navbar.bottom">
423<!-- -->
424</a></div>
425<!-- ======== END OF BOTTOM NAVBAR ======= -->
426</body>
427</html>
Note: See TracBrowser for help on using the repository browser.