source: javadoc/genius/core/config/MultilateralTournamentConfigurationInterface.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: 19.0 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:56 CEST 2018 -->
6<title>MultilateralTournamentConfigurationInterface (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="MultilateralTournamentConfigurationInterface (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/MultilateralTournamentConfigurationInterface.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/config/MultilateralTournamentConfiguration.html" title="class in genius.core.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/config/MultilateralTournamentsConfiguration.html" title="class in genius.core.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/config/MultilateralTournamentConfigurationInterface.html" target="_top">Frames</a></li>
57<li><a href="MultilateralTournamentConfigurationInterface.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>Constr&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>Constr&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.config</div>
96<h2 title="Interface MultilateralTournamentConfigurationInterface" class="title">Interface MultilateralTournamentConfigurationInterface</h2>
97</div>
98<div class="contentContainer">
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Known Implementing Classes:</dt>
104<dd><a href="../../../genius/core/config/MultilateralTournamentConfiguration.html" title="class in genius.core.config">MultilateralTournamentConfiguration</a></dd>
105</dl>
106<hr>
107<br>
108<pre>public interface <span class="typeNameLabel">MultilateralTournamentConfigurationInterface</span></pre>
109<div class="block">Stores the configuration variables
110
111 <p>
112 This object must be serializable so that the configuration can be read from
113 file. Therefore should not contain complex runtime objects but rather
114 <a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository"><code>RepItem</code></a>s. Implementations should be immutable.</div>
115</li>
116</ul>
117</div>
118<div class="summary">
119<ul class="blockList">
120<li class="blockList">
121<!-- ========== METHOD SUMMARY =========== -->
122<ul class="blockList">
123<li class="blockList"><a name="method.summary">
124<!-- -->
125</a>
126<h3>Method Summary</h3>
127<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
128<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></caption>
129<tr>
130<th class="colFirst" scope="col">Modifier and Type</th>
131<th class="colLast" scope="col">Method and Description</th>
132</tr>
133<tr id="i0" class="altColor">
134<td class="colFirst"><code><a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a></code></td>
135<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getDeadline--">getDeadline</a></span>()</code>&nbsp;</td>
136</tr>
137<tr id="i1" class="rowColor">
138<td class="colFirst"><code><a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository">PartyRepItem</a></code></td>
139<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getMediator--">getMediator</a></span>()</code>&nbsp;</td>
140</tr>
141<tr id="i2" class="altColor">
142<td class="colFirst"><code>int</code></td>
143<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getNumPartiesPerSession--">getNumPartiesPerSession</a></span>()</code>&nbsp;</td>
144</tr>
145<tr id="i3" class="rowColor">
146<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&gt;</code></td>
147<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getPartyBItems--">getPartyBItems</a></span>()</code>&nbsp;</td>
148</tr>
149<tr id="i4" class="altColor">
150<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&gt;</code></td>
151<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getPartyItems--">getPartyItems</a></span>()</code>
152<div class="block">read-only list of party repository items.</div>
153</td>
154</tr>
155<tr id="i5" class="rowColor">
156<td class="colFirst"><code><a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a></code></td>
157<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getPersistentDataType--">getPersistentDataType</a></span>()</code>&nbsp;</td>
158</tr>
159<tr id="i6" class="altColor">
160<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&gt;</code></td>
161<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getProfileBItems--">getProfileBItems</a></span>()</code>&nbsp;</td>
162</tr>
163<tr id="i7" class="rowColor">
164<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&gt;</code></td>
165<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getProfileItems--">getProfileItems</a></span>()</code>
166<div class="block">Gets read-only list of profiles used by the parties.</div>
167</td>
168</tr>
169<tr id="i8" class="altColor">
170<td class="colFirst"><code><a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a></code></td>
171<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getProtocolItem--">getProtocolItem</a></span>()</code>
172<div class="block">Gets the protocol to run</div>
173</td>
174</tr>
175<tr id="i9" class="rowColor">
176<td class="colFirst"><code>int</code></td>
177<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getRepeats--">getRepeats</a></span>()</code>
178<div class="block">Gets the number of times to run the tournament.</div>
179</td>
180</tr>
181<tr id="i10" class="altColor">
182<td class="colFirst"><code>boolean</code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#isPrintEnabled--">isPrintEnabled</a></span>()</code>&nbsp;</td>
184</tr>
185<tr id="i11" class="rowColor">
186<td class="colFirst"><code>boolean</code></td>
187<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#isRandomSessionOrder--">isRandomSessionOrder</a></span>()</code>&nbsp;</td>
188</tr>
189<tr id="i12" class="altColor">
190<td class="colFirst"><code>boolean</code></td>
191<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#isRepetitionAllowed--">isRepetitionAllowed</a></span>()</code>
192<div class="block">Gets whether repetition is allowed when generating combinations of
193 agents.</div>
194</td>
195</tr>
196</table>
197</li>
198</ul>
199</li>
200</ul>
201</div>
202<div class="details">
203<ul class="blockList">
204<li class="blockList">
205<!-- ============ METHOD DETAIL ========== -->
206<ul class="blockList">
207<li class="blockList"><a name="method.detail">
208<!-- -->
209</a>
210<h3>Method Detail</h3>
211<a name="getProtocolItem--">
212<!-- -->
213</a>
214<ul class="blockList">
215<li class="blockList">
216<h4>getProtocolItem</h4>
217<pre><a href="../../../genius/core/repository/MultiPartyProtocolRepItem.html" title="class in genius.core.repository">MultiPartyProtocolRepItem</a>&nbsp;getProtocolItem()</pre>
218<div class="block">Gets the protocol to run</div>
219<dl>
220<dt><span class="returnLabel">Returns:</span></dt>
221<dd>the protocol to run</dd>
222</dl>
223</li>
224</ul>
225<a name="getDeadline--">
226<!-- -->
227</a>
228<ul class="blockList">
229<li class="blockList">
230<h4>getDeadline</h4>
231<pre><a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a>&nbsp;getDeadline()</pre>
232<dl>
233<dt><span class="returnLabel">Returns:</span></dt>
234<dd>Deadline for all sessions.</dd>
235</dl>
236</li>
237</ul>
238<a name="getRepeats--">
239<!-- -->
240</a>
241<ul class="blockList">
242<li class="blockList">
243<h4>getRepeats</h4>
244<pre>int&nbsp;getRepeats()</pre>
245<div class="block">Gets the number of times to run the tournament.</div>
246<dl>
247<dt><span class="returnLabel">Returns:</span></dt>
248<dd>the number of tournaments</dd>
249</dl>
250</li>
251</ul>
252<a name="getMediator--">
253<!-- -->
254</a>
255<ul class="blockList">
256<li class="blockList">
257<h4>getMediator</h4>
258<pre><a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository">PartyRepItem</a>&nbsp;getMediator()</pre>
259<dl>
260<dt><span class="returnLabel">Returns:</span></dt>
261<dd>The mediator in use. ignored if protocol does not use mediator.
262 Must be non-null if protocol needs mediator.</dd>
263</dl>
264</li>
265</ul>
266<a name="getPartyItems--">
267<!-- -->
268</a>
269<ul class="blockList">
270<li class="blockList">
271<h4>getPartyItems</h4>
272<pre>java.util.List&lt;<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&gt;&nbsp;getPartyItems()</pre>
273<div class="block">read-only list of party repository items. This may include mediator(s)</div>
274<dl>
275<dt><span class="returnLabel">Returns:</span></dt>
276<dd>a list of all chosen parties. Only a sub-set of the non-mediators
277 will be used in each session, see also
278 <a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getNumPartiesPerSession--"><code>getNumPartiesPerSession()</code></a></dd>
279</dl>
280</li>
281</ul>
282<a name="getProfileItems--">
283<!-- -->
284</a>
285<ul class="blockList">
286<li class="blockList">
287<h4>getProfileItems</h4>
288<pre>java.util.List&lt;<a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&gt;&nbsp;getProfileItems()</pre>
289<div class="block">Gets read-only list of profiles used by the parties. These protocols are
290 used to generate the sessions. The number of available items determines
291 the maximum number of parties in one session.</div>
292<dl>
293<dt><span class="returnLabel">Returns:</span></dt>
294<dd>list of profiles used by the parties</dd>
295</dl>
296</li>
297</ul>
298<a name="getPartyBItems--">
299<!-- -->
300</a>
301<ul class="blockList">
302<li class="blockList">
303<h4>getPartyBItems</h4>
304<pre>java.util.List&lt;<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&gt;&nbsp;getPartyBItems()</pre>
305<dl>
306<dt><span class="returnLabel">Returns:</span></dt>
307<dd>a pool of parties for side B . This is only used if not empty and
308 if <a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getNumPartiesPerSession--"><code>getNumPartiesPerSession()</code></a> =2.</dd>
309</dl>
310</li>
311</ul>
312<a name="getProfileBItems--">
313<!-- -->
314</a>
315<ul class="blockList">
316<li class="blockList">
317<h4>getProfileBItems</h4>
318<pre>java.util.List&lt;<a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&gt;&nbsp;getProfileBItems()</pre>
319<dl>
320<dt><span class="returnLabel">Returns:</span></dt>
321<dd>a pool of profiles for side B. Must be non empty if
322 <a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getPartyBItems--"><code>getPartyBItems()</code></a> is not empty.</dd>
323</dl>
324</li>
325</ul>
326<a name="getNumPartiesPerSession--">
327<!-- -->
328</a>
329<ul class="blockList">
330<li class="blockList">
331<h4>getNumPartiesPerSession</h4>
332<pre>int&nbsp;getNumPartiesPerSession()</pre>
333<dl>
334<dt><span class="returnLabel">Returns:</span></dt>
335<dd>the number of parties (excluding mediators) per session. This can
336 be smaller than size of <a href="../../../genius/core/config/MultilateralTournamentConfigurationInterface.html#getPartyItems--"><code>getPartyItems()</code></a>, then subsets of
337 the party items will be used in each session.</dd>
338</dl>
339</li>
340</ul>
341<a name="isRepetitionAllowed--">
342<!-- -->
343</a>
344<ul class="blockList">
345<li class="blockList">
346<h4>isRepetitionAllowed</h4>
347<pre>boolean&nbsp;isRepetitionAllowed()</pre>
348<div class="block">Gets whether repetition is allowed when generating combinations of
349 agents.</div>
350<dl>
351<dt><span class="returnLabel">Returns:</span></dt>
352<dd>true if allowed</dd>
353</dl>
354</li>
355</ul>
356<a name="isRandomSessionOrder--">
357<!-- -->
358</a>
359<ul class="blockList">
360<li class="blockList">
361<h4>isRandomSessionOrder</h4>
362<pre>boolean&nbsp;isRandomSessionOrder()</pre>
363<dl>
364<dt><span class="returnLabel">Returns:</span></dt>
365<dd>true if the sessions inside a tournament must be randomized.</dd>
366</dl>
367</li>
368</ul>
369<a name="getPersistentDataType--">
370<!-- -->
371</a>
372<ul class="blockList">
373<li class="blockList">
374<h4>getPersistentDataType</h4>
375<pre><a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;getPersistentDataType()</pre>
376<dl>
377<dt><span class="returnLabel">Returns:</span></dt>
378<dd>the persistent data setting for this tournament.</dd>
379</dl>
380</li>
381</ul>
382<a name="isPrintEnabled--">
383<!-- -->
384</a>
385<ul class="blockListLast">
386<li class="blockList">
387<h4>isPrintEnabled</h4>
388<pre>boolean&nbsp;isPrintEnabled()</pre>
389<dl>
390<dt><span class="returnLabel">Returns:</span></dt>
391<dd>true iff print (using System.out.println) is enabled. If not, it
392 is suppressed.</dd>
393</dl>
394</li>
395</ul>
396</li>
397</ul>
398</li>
399</ul>
400</div>
401</div>
402<!-- ========= END OF CLASS DATA ========= -->
403<!-- ======= START OF BOTTOM NAVBAR ====== -->
404<div class="bottomNav"><a name="navbar.bottom">
405<!-- -->
406</a>
407<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
408<a name="navbar.bottom.firstrow">
409<!-- -->
410</a>
411<ul class="navList" title="Navigation">
412<li><a href="../../../overview-summary.html">Overview</a></li>
413<li><a href="package-summary.html">Package</a></li>
414<li class="navBarCell1Rev">Class</li>
415<li><a href="class-use/MultilateralTournamentConfigurationInterface.html">Use</a></li>
416<li><a href="package-tree.html">Tree</a></li>
417<li><a href="../../../deprecated-list.html">Deprecated</a></li>
418<li><a href="../../../index-all.html">Index</a></li>
419<li><a href="../../../help-doc.html">Help</a></li>
420</ul>
421</div>
422<div class="subNav">
423<ul class="navList">
424<li><a href="../../../genius/core/config/MultilateralTournamentConfiguration.html" title="class in genius.core.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
425<li><a href="../../../genius/core/config/MultilateralTournamentsConfiguration.html" title="class in genius.core.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
426</ul>
427<ul class="navList">
428<li><a href="../../../index.html?genius/core/config/MultilateralTournamentConfigurationInterface.html" target="_top">Frames</a></li>
429<li><a href="MultilateralTournamentConfigurationInterface.html" target="_top">No&nbsp;Frames</a></li>
430</ul>
431<ul class="navList" id="allclasses_navbar_bottom">
432<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
433</ul>
434<div>
435<script type="text/javascript"><!--
436 allClassesLink = document.getElementById("allclasses_navbar_bottom");
437 if(window==top) {
438 allClassesLink.style.display = "block";
439 }
440 else {
441 allClassesLink.style.display = "none";
442 }
443 //-->
444</script>
445</div>
446<div>
447<ul class="subNavList">
448<li>Summary:&nbsp;</li>
449<li>Nested&nbsp;|&nbsp;</li>
450<li>Field&nbsp;|&nbsp;</li>
451<li>Constr&nbsp;|&nbsp;</li>
452<li><a href="#method.summary">Method</a></li>
453</ul>
454<ul class="subNavList">
455<li>Detail:&nbsp;</li>
456<li>Field&nbsp;|&nbsp;</li>
457<li>Constr&nbsp;|&nbsp;</li>
458<li><a href="#method.detail">Method</a></li>
459</ul>
460</div>
461<a name="skip.navbar.bottom">
462<!-- -->
463</a></div>
464<!-- ======== END OF BOTTOM NAVBAR ======= -->
465</body>
466</html>
Note: See TracBrowser for help on using the repository browser.