source: javadoc/genius/core/session/SessionConfiguration.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: 17.9 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:58 CEST 2018 -->
6<title>SessionConfiguration (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="SessionConfiguration (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/SessionConfiguration.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/session/Session.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/session/SessionConfiguration.html" target="_top">Frames</a></li>
57<li><a href="SessionConfiguration.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.session</div>
96<h2 title="Class SessionConfiguration" class="title">Class SessionConfiguration</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.session.SessionConfiguration</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/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">SessionConfiguration</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></pre>
119<div class="block">Holds all information to start and run a session. Contains only references,
120 no actual agent instantiations. Immutable implementation</div>
121</li>
122</ul>
123</div>
124<div class="summary">
125<ul class="blockList">
126<li class="blockList">
127<!-- ======== CONSTRUCTOR SUMMARY ======== -->
128<ul class="blockList">
129<li class="blockList"><a name="constructor.summary">
130<!-- -->
131</a>
132<h3>Constructor Summary</h3>
133<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
134<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
135<tr>
136<th class="colOne" scope="col">Constructor and Description</th>
137</tr>
138<tr class="altColor">
139<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#SessionConfiguration-genius.core.repository.MultiPartyProtocolRepItem-genius.core.session.Participant-java.util.List-genius.core.Deadline-genius.core.persistent.PersistentDataType-">SessionConfiguration</a></span>(<a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a>&nbsp;protocol,
140 <a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&nbsp;mediator,
141 java.util.List&lt;<a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&gt;&nbsp;parties,
142 <a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a>&nbsp;deadline,
143 <a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;type)</code>&nbsp;</td>
144</tr>
145</table>
146</li>
147</ul>
148<!-- ========== METHOD SUMMARY =========== -->
149<ul class="blockList">
150<li class="blockList"><a name="method.summary">
151<!-- -->
152</a>
153<h3>Method Summary</h3>
154<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
155<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
156<tr>
157<th class="colFirst" scope="col">Modifier and Type</th>
158<th class="colLast" scope="col">Method and Description</th>
159</tr>
160<tr id="i0" class="altColor">
161<td class="colFirst"><code><a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a></code></td>
162<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getDeadline--">getDeadline</a></span>()</code>&nbsp;</td>
163</tr>
164<tr id="i1" class="rowColor">
165<td class="colFirst"><code><a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a></code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getMediator--">getMediator</a></span>()</code>&nbsp;</td>
167</tr>
168<tr id="i2" class="altColor">
169<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
170<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getParticipantNames--">getParticipantNames</a></span>()</code>&nbsp;</td>
171</tr>
172<tr id="i3" class="rowColor">
173<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&gt;</code></td>
174<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getParties--">getParties</a></span>()</code>&nbsp;</td>
175</tr>
176<tr id="i4" class="altColor">
177<td class="colFirst"><code><a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a></code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getPersistentDataType--">getPersistentDataType</a></span>()</code>&nbsp;</td>
179</tr>
180<tr id="i5" class="rowColor">
181<td class="colFirst"><code><a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a></code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#getProtocol--">getProtocol</a></span>()</code>&nbsp;</td>
183</tr>
184<tr id="i6" class="altColor">
185<td class="colFirst"><code>java.lang.String</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionConfiguration.html#toString--">toString</a></span>()</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="SessionConfiguration-genius.core.repository.MultiPartyProtocolRepItem-genius.core.session.Participant-java.util.List-genius.core.Deadline-genius.core.persistent.PersistentDataType-">
211<!-- -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>SessionConfiguration</h4>
216<pre>public&nbsp;SessionConfiguration(<a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a>&nbsp;protocol,
217 <a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&nbsp;mediator,
218 java.util.List&lt;<a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&gt;&nbsp;parties,
219 <a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a>&nbsp;deadline,
220 <a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;type)</pre>
221</li>
222</ul>
223</li>
224</ul>
225<!-- ============ METHOD DETAIL ========== -->
226<ul class="blockList">
227<li class="blockList"><a name="method.detail">
228<!-- -->
229</a>
230<h3>Method Detail</h3>
231<a name="getProtocol--">
232<!-- -->
233</a>
234<ul class="blockList">
235<li class="blockList">
236<h4>getProtocol</h4>
237<pre>public&nbsp;<a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a>&nbsp;getProtocol()</pre>
238<dl>
239<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
240<dd><code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></code></dd>
241<dt><span class="returnLabel">Returns:</span></dt>
242<dd>the protocol</dd>
243</dl>
244</li>
245</ul>
246<a name="getParties--">
247<!-- -->
248</a>
249<ul class="blockList">
250<li class="blockList">
251<h4>getParties</h4>
252<pre>public&nbsp;java.util.List&lt;<a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&gt;&nbsp;getParties()</pre>
253<dl>
254<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
255<dd><code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getParties--">getParties</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></code></dd>
256<dt><span class="returnLabel">Returns:</span></dt>
257<dd>the normal parties, excluding the mediator(s).</dd>
258</dl>
259</li>
260</ul>
261<a name="getDeadline--">
262<!-- -->
263</a>
264<ul class="blockList">
265<li class="blockList">
266<h4>getDeadline</h4>
267<pre>public&nbsp;<a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a>&nbsp;getDeadline()</pre>
268<dl>
269<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
270<dd><code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getDeadline--">getDeadline</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></code></dd>
271<dt><span class="returnLabel">Returns:</span></dt>
272<dd>the deadline setting</dd>
273</dl>
274</li>
275</ul>
276<a name="toString--">
277<!-- -->
278</a>
279<ul class="blockList">
280<li class="blockList">
281<h4>toString</h4>
282<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
283<dl>
284<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
285<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
286</dl>
287</li>
288</ul>
289<a name="getMediator--">
290<!-- -->
291</a>
292<ul class="blockList">
293<li class="blockList">
294<h4>getMediator</h4>
295<pre>public&nbsp;<a href="../../../genius/core/session/Participant.html" title="class in genius.core.session">Participant</a>&nbsp;getMediator()</pre>
296<dl>
297<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
298<dd><code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getMediator--">getMediator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></code></dd>
299<dt><span class="returnLabel">Returns:</span></dt>
300<dd>the mediator. Only valid when <a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getProtocol--"><code>MultilateralSessionConfiguration.getProtocol()</code></a> returns a
301 protocol that needs mediator.</dd>
302</dl>
303</li>
304</ul>
305<a name="getPersistentDataType--">
306<!-- -->
307</a>
308<ul class="blockList">
309<li class="blockList">
310<h4>getPersistentDataType</h4>
311<pre>public&nbsp;<a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;getPersistentDataType()</pre>
312<dl>
313<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
314<dd><code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html#getPersistentDataType--">getPersistentDataType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/session/MultilateralSessionConfiguration.html" title="interface in genius.core.session">MultilateralSessionConfiguration</a></code></dd>
315<dt><span class="returnLabel">Returns:</span></dt>
316<dd>persistent data type to use for this run</dd>
317</dl>
318</li>
319</ul>
320<a name="getParticipantNames--">
321<!-- -->
322</a>
323<ul class="blockListLast">
324<li class="blockList">
325<h4>getParticipantNames</h4>
326<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getParticipantNames()</pre>
327<dl>
328<dt><span class="returnLabel">Returns:</span></dt>
329<dd>simple list of names</dd>
330</dl>
331</li>
332</ul>
333</li>
334</ul>
335</li>
336</ul>
337</div>
338</div>
339<!-- ========= END OF CLASS DATA ========= -->
340<!-- ======= START OF BOTTOM NAVBAR ====== -->
341<div class="bottomNav"><a name="navbar.bottom">
342<!-- -->
343</a>
344<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
345<a name="navbar.bottom.firstrow">
346<!-- -->
347</a>
348<ul class="navList" title="Navigation">
349<li><a href="../../../overview-summary.html">Overview</a></li>
350<li><a href="package-summary.html">Package</a></li>
351<li class="navBarCell1Rev">Class</li>
352<li><a href="class-use/SessionConfiguration.html">Use</a></li>
353<li><a href="package-tree.html">Tree</a></li>
354<li><a href="../../../deprecated-list.html">Deprecated</a></li>
355<li><a href="../../../index-all.html">Index</a></li>
356<li><a href="../../../help-doc.html">Help</a></li>
357</ul>
358</div>
359<div class="subNav">
360<ul class="navList">
361<li><a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
362<li><a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
363</ul>
364<ul class="navList">
365<li><a href="../../../index.html?genius/core/session/SessionConfiguration.html" target="_top">Frames</a></li>
366<li><a href="SessionConfiguration.html" target="_top">No&nbsp;Frames</a></li>
367</ul>
368<ul class="navList" id="allclasses_navbar_bottom">
369<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
370</ul>
371<div>
372<script type="text/javascript"><!--
373 allClassesLink = document.getElementById("allclasses_navbar_bottom");
374 if(window==top) {
375 allClassesLink.style.display = "block";
376 }
377 else {
378 allClassesLink.style.display = "none";
379 }
380 //-->
381</script>
382</div>
383<div>
384<ul class="subNavList">
385<li>Summary:&nbsp;</li>
386<li>Nested&nbsp;|&nbsp;</li>
387<li>Field&nbsp;|&nbsp;</li>
388<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
389<li><a href="#method.summary">Method</a></li>
390</ul>
391<ul class="subNavList">
392<li>Detail:&nbsp;</li>
393<li>Field&nbsp;|&nbsp;</li>
394<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
395<li><a href="#method.detail">Method</a></li>
396</ul>
397</div>
398<a name="skip.navbar.bottom">
399<!-- -->
400</a></div>
401<!-- ======== END OF BOTTOM NAVBAR ======= -->
402</body>
403</html>
Note: See TracBrowser for help on using the repository browser.