source: javadoc/genius/core/protocol/MediatorProtocol.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: 15.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>MediatorProtocol (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="MediatorProtocol (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":9,"i1":9};
22var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/MediatorProtocol.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/protocol/MediatorFeedbackBasedProtocol.html" title="class in genius.core.protocol"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/protocol/MediatorProtocol.html" target="_top">Frames</a></li>
57<li><a href="MediatorProtocol.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><a href="#fields.inherited.from.class.genius.core.protocol.DefaultMultilateralProtocol">Field</a>&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.protocol</div>
96<h2 title="Class MediatorProtocol" class="title">Class MediatorProtocol</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><a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html" title="class in genius.core.protocol">genius.core.protocol.DefaultMultilateralProtocol</a></li>
104<li>
105<ul class="inheritance">
106<li>genius.core.protocol.MediatorProtocol</li>
107</ul>
108</li>
109</ul>
110</li>
111</ul>
112<div class="description">
113<ul class="blockList">
114<li class="blockList">
115<dl>
116<dt>All Implemented Interfaces:</dt>
117<dd><a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a></dd>
118</dl>
119<dl>
120<dt>Direct Known Subclasses:</dt>
121<dd><a href="../../../genius/core/protocol/MediatorFeedbackBasedProtocol.html" title="class in genius.core.protocol">MediatorFeedbackBasedProtocol</a>, <a href="../../../genius/core/protocol/SimpleMediatorBasedProtocol.html" title="class in genius.core.protocol">SimpleMediatorBasedProtocol</a></dd>
122</dl>
123<hr>
124<br>
125<pre>public abstract class <span class="typeNameLabel">MediatorProtocol</span>
126extends <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html" title="class in genius.core.protocol">DefaultMultilateralProtocol</a></pre>
127<div class="block">Base class for all mediator-based protocols</div>
128<dl>
129<dt><span class="simpleTagLabel">Author:</span></dt>
130<dd>David Festen</dd>
131</dl>
132</li>
133</ul>
134</div>
135<div class="summary">
136<ul class="blockList">
137<li class="blockList">
138<!-- =========== FIELD SUMMARY =========== -->
139<ul class="blockList">
140<li class="blockList"><a name="field.summary">
141<!-- -->
142</a>
143<h3>Field Summary</h3>
144<ul class="blockList">
145<li class="blockList"><a name="fields.inherited.from.class.genius.core.protocol.DefaultMultilateralProtocol">
146<!-- -->
147</a>
148<h3>Fields inherited from class&nbsp;genius.core.protocol.<a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html" title="class in genius.core.protocol">DefaultMultilateralProtocol</a></h3>
149<code><a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#isAborted">isAborted</a></code></li>
150</ul>
151</li>
152</ul>
153<!-- ======== CONSTRUCTOR SUMMARY ======== -->
154<ul class="blockList">
155<li class="blockList"><a name="constructor.summary">
156<!-- -->
157</a>
158<h3>Constructor Summary</h3>
159<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
160<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
161<tr>
162<th class="colOne" scope="col">Constructor and Description</th>
163</tr>
164<tr class="altColor">
165<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/protocol/MediatorProtocol.html#MediatorProtocol--">MediatorProtocol</a></span>()</code>&nbsp;</td>
166</tr>
167</table>
168</li>
169</ul>
170<!-- ========== METHOD SUMMARY =========== -->
171<ul class="blockList">
172<li class="blockList"><a name="method.summary">
173<!-- -->
174</a>
175<h3>Method Summary</h3>
176<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
177<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
178<tr>
179<th class="colFirst" scope="col">Modifier and Type</th>
180<th class="colLast" scope="col">Method and Description</th>
181</tr>
182<tr id="i0" class="altColor">
183<td class="colFirst"><code>static <a href="../../../genius/core/parties/Mediator.html" title="interface in genius.core.parties">Mediator</a></code></td>
184<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/protocol/MediatorProtocol.html#getMediator-java.util.List-">getMediator</a></span>(java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;&nbsp;parties)</code>
185<div class="block">Returns the first mediator from a list of parties</div>
186</td>
187</tr>
188<tr id="i1" class="rowColor">
189<td class="colFirst"><code>static java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;</code></td>
190<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/protocol/MediatorProtocol.html#getNonMediators-java.util.List-">getNonMediators</a></span>(java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;&nbsp;parties)</code>
191<div class="block">Get the non-mediator parties.</div>
192</td>
193</tr>
194</table>
195<ul class="blockList">
196<li class="blockList"><a name="methods.inherited.from.class.genius.core.protocol.DefaultMultilateralProtocol">
197<!-- -->
198</a>
199<h3>Methods inherited from class&nbsp;genius.core.protocol.<a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html" title="class in genius.core.protocol">DefaultMultilateralProtocol</a></h3>
200<code><a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#afterSession-genius.core.session.Session-java.util.List-">afterSession</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#applyAction-genius.core.actions.Action-genius.core.session.Session-">applyAction</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#beforeSession-genius.core.session.Session-java.util.List-">beforeSession</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#checkOffer-genius.core.actions.Offer-">checkOffer</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#endNegotiation--">endNegotiation</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#endNegotiation-java.lang.String-">endNegotiation</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#exclude-java.util.Collection-java.lang.Class-">exclude</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#getActionListeners-java.util.List-">getActionListeners</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#getCurrentAgreement-genius.core.session.Session-java.util.List-">getCurrentAgreement</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#getNumberOfAgreeingParties-genius.core.session.Session-java.util.List-">getNumberOfAgreeingParties</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#getRoundStructure-java.util.List-genius.core.session.Session-">getRoundStructure</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#includeOnly-java.util.Collection-java.lang.Class-">includeOnly</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#isFinished-genius.core.session.Session-java.util.List-">isFinished</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#listenToAll-java.util.List-">listenToAll</a>, <a href="../../../genius/core/protocol/DefaultMultilateralProtocol.html#listenToNone-java.util.List-">listenToNone</a></code></li>
201</ul>
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, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
208</ul>
209</li>
210</ul>
211</li>
212</ul>
213</div>
214<div class="details">
215<ul class="blockList">
216<li class="blockList">
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218<ul class="blockList">
219<li class="blockList"><a name="constructor.detail">
220<!-- -->
221</a>
222<h3>Constructor Detail</h3>
223<a name="MediatorProtocol--">
224<!-- -->
225</a>
226<ul class="blockListLast">
227<li class="blockList">
228<h4>MediatorProtocol</h4>
229<pre>public&nbsp;MediatorProtocol()</pre>
230</li>
231</ul>
232</li>
233</ul>
234<!-- ============ METHOD DETAIL ========== -->
235<ul class="blockList">
236<li class="blockList"><a name="method.detail">
237<!-- -->
238</a>
239<h3>Method Detail</h3>
240<a name="getMediator-java.util.List-">
241<!-- -->
242</a>
243<ul class="blockList">
244<li class="blockList">
245<h4>getMediator</h4>
246<pre>public static&nbsp;<a href="../../../genius/core/parties/Mediator.html" title="interface in genius.core.parties">Mediator</a>&nbsp;getMediator(java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;&nbsp;parties)</pre>
247<div class="block">Returns the first mediator from a list of parties</div>
248<dl>
249<dt><span class="paramLabel">Parameters:</span></dt>
250<dd><code>parties</code> - The list of parties to find the mediator in</dd>
251<dt><span class="returnLabel">Returns:</span></dt>
252<dd>The first mediator in the given list, or null if no such entity
253 exists.</dd>
254</dl>
255</li>
256</ul>
257<a name="getNonMediators-java.util.List-">
258<!-- -->
259</a>
260<ul class="blockListLast">
261<li class="blockList">
262<h4>getNonMediators</h4>
263<pre>public static&nbsp;java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;&nbsp;getNonMediators(java.util.List&lt;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&gt;&nbsp;parties)</pre>
264<div class="block">Get the non-mediator parties. assumption: there are only zero or one
265 mediators in the list</div>
266<dl>
267<dt><span class="paramLabel">Parameters:</span></dt>
268<dd><code>parties</code> - The list of parties with mediator</dd>
269<dt><span class="returnLabel">Returns:</span></dt>
270<dd>The given without the mediators</dd>
271</dl>
272</li>
273</ul>
274</li>
275</ul>
276</li>
277</ul>
278</div>
279</div>
280<!-- ========= END OF CLASS DATA ========= -->
281<!-- ======= START OF BOTTOM NAVBAR ====== -->
282<div class="bottomNav"><a name="navbar.bottom">
283<!-- -->
284</a>
285<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
286<a name="navbar.bottom.firstrow">
287<!-- -->
288</a>
289<ul class="navList" title="Navigation">
290<li><a href="../../../overview-summary.html">Overview</a></li>
291<li><a href="package-summary.html">Package</a></li>
292<li class="navBarCell1Rev">Class</li>
293<li><a href="class-use/MediatorProtocol.html">Use</a></li>
294<li><a href="package-tree.html">Tree</a></li>
295<li><a href="../../../deprecated-list.html">Deprecated</a></li>
296<li><a href="../../../index-all.html">Index</a></li>
297<li><a href="../../../help-doc.html">Help</a></li>
298</ul>
299</div>
300<div class="subNav">
301<ul class="navList">
302<li><a href="../../../genius/core/protocol/MediatorFeedbackBasedProtocol.html" title="class in genius.core.protocol"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
303<li><a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
304</ul>
305<ul class="navList">
306<li><a href="../../../index.html?genius/core/protocol/MediatorProtocol.html" target="_top">Frames</a></li>
307<li><a href="MediatorProtocol.html" target="_top">No&nbsp;Frames</a></li>
308</ul>
309<ul class="navList" id="allclasses_navbar_bottom">
310<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
311</ul>
312<div>
313<script type="text/javascript"><!--
314 allClassesLink = document.getElementById("allclasses_navbar_bottom");
315 if(window==top) {
316 allClassesLink.style.display = "block";
317 }
318 else {
319 allClassesLink.style.display = "none";
320 }
321 //-->
322</script>
323</div>
324<div>
325<ul class="subNavList">
326<li>Summary:&nbsp;</li>
327<li>Nested&nbsp;|&nbsp;</li>
328<li><a href="#fields.inherited.from.class.genius.core.protocol.DefaultMultilateralProtocol">Field</a>&nbsp;|&nbsp;</li>
329<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
330<li><a href="#method.summary">Method</a></li>
331</ul>
332<ul class="subNavList">
333<li>Detail:&nbsp;</li>
334<li>Field&nbsp;|&nbsp;</li>
335<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
336<li><a href="#method.detail">Method</a></li>
337</ul>
338</div>
339<a name="skip.navbar.bottom">
340<!-- -->
341</a></div>
342<!-- ======== END OF BOTTOM NAVBAR ======= -->
343</body>
344</html>
Note: See TracBrowser for help on using the repository browser.