[1] | 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>AgentAdapter (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="AgentAdapter (Genius Core Documentation)";
|
---|
| 16 | }
|
---|
| 17 | }
|
---|
| 18 | catch(err) {
|
---|
| 19 | }
|
---|
| 20 | //-->
|
---|
| 21 | var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
|
---|
| 22 | var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
|
---|
| 23 | var altColor = "altColor";
|
---|
| 24 | var rowColor = "rowColor";
|
---|
| 25 | var tableTab = "tableTab";
|
---|
| 26 | var 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/AgentAdapter.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/Agent.html" title="class in genius.core"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
| 53 | <li><a href="../../genius/core/AgentID.html" title="class in genius.core"><span class="typeNameLink">Next Class</span></a></li>
|
---|
| 54 | </ul>
|
---|
| 55 | <ul class="navList">
|
---|
| 56 | <li><a href="../../index.html?genius/core/AgentAdapter.html" target="_top">Frames</a></li>
|
---|
| 57 | <li><a href="AgentAdapter.html" target="_top">No Frames</a></li>
|
---|
| 58 | </ul>
|
---|
| 59 | <ul class="navList" id="allclasses_navbar_top">
|
---|
| 60 | <li><a href="../../allclasses-noframe.html">All 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: </li>
|
---|
| 77 | <li>Nested | </li>
|
---|
| 78 | <li>Field | </li>
|
---|
| 79 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
| 80 | <li><a href="#method.summary">Method</a></li>
|
---|
| 81 | </ul>
|
---|
| 82 | <ul class="subNavList">
|
---|
| 83 | <li>Detail: </li>
|
---|
| 84 | <li>Field | </li>
|
---|
| 85 | <li><a href="#constructor.detail">Constr</a> | </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</div>
|
---|
| 96 | <h2 title="Class AgentAdapter" class="title">Class AgentAdapter</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.AgentAdapter</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/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>, java.io.Serializable</dd>
|
---|
| 113 | </dl>
|
---|
| 114 | <dl>
|
---|
| 115 | <dt>Direct Known Subclasses:</dt>
|
---|
| 116 | <dd><a href="../../genius/core/Agent.html" title="class in genius.core">Agent</a></dd>
|
---|
| 117 | </dl>
|
---|
| 118 | <hr>
|
---|
| 119 | <br>
|
---|
| 120 | <pre>public abstract class <span class="typeNameLabel">AgentAdapter</span>
|
---|
| 121 | extends java.lang.Object
|
---|
| 122 | implements <a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></pre>
|
---|
| 123 | <div class="block">Adapts <a href="../../genius/core/Agent.html" title="class in genius.core"><code>Agent</code></a> to the <a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> so that legacy agents
|
---|
| 124 | can be run in the new multiparty system. Notice that these agents could
|
---|
| 125 | handle only 1 opponent, and thus may behave weird if presented with more than
|
---|
| 126 | one opponent.
|
---|
| 127 |
|
---|
| 128 | What is unusual (in the Java sense) is that Agent extends this, not the other
|
---|
| 129 | way round. This way, all old agents also become a NegotiationParty.</div>
|
---|
| 130 | <dl>
|
---|
| 131 | <dt><span class="seeLabel">See Also:</span></dt>
|
---|
| 132 | <dd><a href="../../serialized-form.html#genius.core.AgentAdapter">Serialized Form</a></dd>
|
---|
| 133 | </dl>
|
---|
| 134 | </li>
|
---|
| 135 | </ul>
|
---|
| 136 | </div>
|
---|
| 137 | <div class="summary">
|
---|
| 138 | <ul class="blockList">
|
---|
| 139 | <li class="blockList">
|
---|
| 140 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
| 141 | <ul class="blockList">
|
---|
| 142 | <li class="blockList"><a name="constructor.summary">
|
---|
| 143 | <!-- -->
|
---|
| 144 | </a>
|
---|
| 145 | <h3>Constructor Summary</h3>
|
---|
| 146 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
---|
| 147 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
---|
| 148 | <tr>
|
---|
| 149 | <th class="colOne" scope="col">Constructor and Description</th>
|
---|
| 150 | </tr>
|
---|
| 151 | <tr class="altColor">
|
---|
| 152 | <td class="colOne"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#AgentAdapter--">AgentAdapter</a></span>()</code> </td>
|
---|
| 153 | </tr>
|
---|
| 154 | </table>
|
---|
| 155 | </li>
|
---|
| 156 | </ul>
|
---|
| 157 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
| 158 | <ul class="blockList">
|
---|
| 159 | <li class="blockList"><a name="method.summary">
|
---|
| 160 | <!-- -->
|
---|
| 161 | </a>
|
---|
| 162 | <h3>Method Summary</h3>
|
---|
| 163 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
---|
| 164 | <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
---|
| 165 | <tr>
|
---|
| 166 | <th class="colFirst" scope="col">Modifier and Type</th>
|
---|
| 167 | <th class="colLast" scope="col">Method and Description</th>
|
---|
| 168 | </tr>
|
---|
| 169 | <tr id="i0" class="altColor">
|
---|
| 170 | <td class="colFirst"><code><a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></code></td>
|
---|
| 171 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#chooseAction-java.util.List-">chooseAction</a></span>(java.util.List<java.lang.Class<? extends <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>>> possibleActions)</code>
|
---|
| 172 | <div class="block">When this function is called, it is expected that the Party chooses one
|
---|
| 173 | of the actions from the possible action list and returns an instance of
|
---|
| 174 | the chosen action.</div>
|
---|
| 175 | </td>
|
---|
| 176 | </tr>
|
---|
| 177 | <tr id="i1" class="rowColor">
|
---|
| 178 | <td class="colFirst"><code>protected abstract <a href="../../genius/core/Agent.html" title="class in genius.core">Agent</a></code></td>
|
---|
| 179 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#getAgent--">getAgent</a></span>()</code> </td>
|
---|
| 180 | </tr>
|
---|
| 181 | <tr id="i2" class="altColor">
|
---|
| 182 | <td class="colFirst"><code>java.lang.String</code></td>
|
---|
| 183 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#getDescription--">getDescription</a></span>()</code>
|
---|
| 184 | <div class="block">This is a convenience wrapper so that we don't have to fix all old agent
|
---|
| 185 | descriptions (these used to be in the xml file)</div>
|
---|
| 186 | </td>
|
---|
| 187 | </tr>
|
---|
| 188 | <tr id="i3" class="rowColor">
|
---|
| 189 | <td class="colFirst"><code>java.lang.Class<? extends <a href="../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a>></code></td>
|
---|
| 190 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#getProtocol--">getProtocol</a></span>()</code>
|
---|
| 191 | <div class="block">Get the protocol that this party supports.</div>
|
---|
| 192 | </td>
|
---|
| 193 | </tr>
|
---|
| 194 | <tr id="i4" class="altColor">
|
---|
| 195 | <td class="colFirst"><code>void</code></td>
|
---|
| 196 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#init-genius.core.parties.NegotiationInfo-">init</a></span>(<a href="../../genius/core/parties/NegotiationInfo.html" title="class in genius.core.parties">NegotiationInfo</a> info)</code>
|
---|
| 197 | <div class="block">Initializes the party, informing it of many negotiation details.</div>
|
---|
| 198 | </td>
|
---|
| 199 | </tr>
|
---|
| 200 | <tr id="i5" class="rowColor">
|
---|
| 201 | <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td>
|
---|
| 202 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#negotiationEnded-genius.core.Bid-">negotiationEnded</a></span>(<a href="../../genius/core/Bid.html" title="class in genius.core">Bid</a> acceptedBid)</code>
|
---|
| 203 | <div class="block">This is called to inform the agent that the negotiation has been ended.</div>
|
---|
| 204 | </td>
|
---|
| 205 | </tr>
|
---|
| 206 | <tr id="i6" class="altColor">
|
---|
| 207 | <td class="colFirst"><code>void</code></td>
|
---|
| 208 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentAdapter.html#receiveMessage-genius.core.AgentID-genius.core.actions.Action-">receiveMessage</a></span>(<a href="../../genius/core/AgentID.html" title="class in genius.core">AgentID</a> sender,
|
---|
| 209 | <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a> action)</code>
|
---|
| 210 | <div class="block">This method is called to inform the party that another
|
---|
| 211 | <a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> chose an <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a>.</div>
|
---|
| 212 | </td>
|
---|
| 213 | </tr>
|
---|
| 214 | </table>
|
---|
| 215 | <ul class="blockList">
|
---|
| 216 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
---|
| 217 | <!-- -->
|
---|
| 218 | </a>
|
---|
| 219 | <h3>Methods inherited from class java.lang.Object</h3>
|
---|
| 220 | <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
---|
| 221 | </ul>
|
---|
| 222 | </li>
|
---|
| 223 | </ul>
|
---|
| 224 | </li>
|
---|
| 225 | </ul>
|
---|
| 226 | </div>
|
---|
| 227 | <div class="details">
|
---|
| 228 | <ul class="blockList">
|
---|
| 229 | <li class="blockList">
|
---|
| 230 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
| 231 | <ul class="blockList">
|
---|
| 232 | <li class="blockList"><a name="constructor.detail">
|
---|
| 233 | <!-- -->
|
---|
| 234 | </a>
|
---|
| 235 | <h3>Constructor Detail</h3>
|
---|
| 236 | <a name="AgentAdapter--">
|
---|
| 237 | <!-- -->
|
---|
| 238 | </a>
|
---|
| 239 | <ul class="blockListLast">
|
---|
| 240 | <li class="blockList">
|
---|
| 241 | <h4>AgentAdapter</h4>
|
---|
| 242 | <pre>public AgentAdapter()</pre>
|
---|
| 243 | </li>
|
---|
| 244 | </ul>
|
---|
| 245 | </li>
|
---|
| 246 | </ul>
|
---|
| 247 | <!-- ============ METHOD DETAIL ========== -->
|
---|
| 248 | <ul class="blockList">
|
---|
| 249 | <li class="blockList"><a name="method.detail">
|
---|
| 250 | <!-- -->
|
---|
| 251 | </a>
|
---|
| 252 | <h3>Method Detail</h3>
|
---|
| 253 | <a name="getAgent--">
|
---|
| 254 | <!-- -->
|
---|
| 255 | </a>
|
---|
| 256 | <ul class="blockList">
|
---|
| 257 | <li class="blockList">
|
---|
| 258 | <h4>getAgent</h4>
|
---|
| 259 | <pre>protected abstract <a href="../../genius/core/Agent.html" title="class in genius.core">Agent</a> getAgent()</pre>
|
---|
| 260 | <dl>
|
---|
| 261 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
| 262 | <dd>the actual agent that is being adapted.</dd>
|
---|
| 263 | </dl>
|
---|
| 264 | </li>
|
---|
| 265 | </ul>
|
---|
| 266 | <a name="init-genius.core.parties.NegotiationInfo-">
|
---|
| 267 | <!-- -->
|
---|
| 268 | </a>
|
---|
| 269 | <ul class="blockList">
|
---|
| 270 | <li class="blockList">
|
---|
| 271 | <h4>init</h4>
|
---|
| 272 | <pre>public final void init(<a href="../../genius/core/parties/NegotiationInfo.html" title="class in genius.core.parties">NegotiationInfo</a> info)</pre>
|
---|
| 273 | <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../genius/core/parties/NegotiationParty.html#init-genius.core.parties.NegotiationInfo-">NegotiationParty</a></code></span></div>
|
---|
| 274 | <div class="block">Initializes the party, informing it of many negotiation details. This
|
---|
| 275 | MUST be called exactly once, immediately after construction of any class
|
---|
| 276 | implementing this.</div>
|
---|
| 277 | <dl>
|
---|
| 278 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 279 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#init-genius.core.parties.NegotiationInfo-">init</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 280 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
| 281 | <dd><code>info</code> - information about the negotiation that this party is part of.</dd>
|
---|
| 282 | </dl>
|
---|
| 283 | </li>
|
---|
| 284 | </ul>
|
---|
| 285 | <a name="chooseAction-java.util.List-">
|
---|
| 286 | <!-- -->
|
---|
| 287 | </a>
|
---|
| 288 | <ul class="blockList">
|
---|
| 289 | <li class="blockList">
|
---|
| 290 | <h4>chooseAction</h4>
|
---|
| 291 | <pre>public final <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a> chooseAction(java.util.List<java.lang.Class<? extends <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>>> possibleActions)</pre>
|
---|
| 292 | <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../genius/core/parties/NegotiationParty.html#chooseAction-java.util.List-">NegotiationParty</a></code></span></div>
|
---|
| 293 | <div class="block">When this function is called, it is expected that the Party chooses one
|
---|
| 294 | of the actions from the possible action list and returns an instance of
|
---|
| 295 | the chosen action.</div>
|
---|
| 296 | <dl>
|
---|
| 297 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 298 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#chooseAction-java.util.List-">chooseAction</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 299 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
| 300 | <dd><code>possibleActions</code> - List of all actions possible.</dd>
|
---|
| 301 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
| 302 | <dd>The chosen <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a>.</dd>
|
---|
| 303 | </dl>
|
---|
| 304 | </li>
|
---|
| 305 | </ul>
|
---|
| 306 | <a name="receiveMessage-genius.core.AgentID-genius.core.actions.Action-">
|
---|
| 307 | <!-- -->
|
---|
| 308 | </a>
|
---|
| 309 | <ul class="blockList">
|
---|
| 310 | <li class="blockList">
|
---|
| 311 | <h4>receiveMessage</h4>
|
---|
| 312 | <pre>public final void receiveMessage(<a href="../../genius/core/AgentID.html" title="class in genius.core">AgentID</a> sender,
|
---|
| 313 | <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a> action)</pre>
|
---|
| 314 | <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../genius/core/parties/NegotiationParty.html#receiveMessage-genius.core.AgentID-genius.core.actions.Action-">NegotiationParty</a></code></span></div>
|
---|
| 315 | <div class="block">This method is called to inform the party that another
|
---|
| 316 | <a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> chose an <a href="../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a>.</div>
|
---|
| 317 | <dl>
|
---|
| 318 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 319 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#receiveMessage-genius.core.AgentID-genius.core.actions.Action-">receiveMessage</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 320 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
| 321 | <dd><code>sender</code> - The initiator of the action.This is either the AgentID, or
|
---|
| 322 | null if the sender is not an agent (e.g., the protocol).</dd>
|
---|
| 323 | <dd><code>action</code> - The action performed</dd>
|
---|
| 324 | </dl>
|
---|
| 325 | </li>
|
---|
| 326 | </ul>
|
---|
| 327 | <a name="getDescription--">
|
---|
| 328 | <!-- -->
|
---|
| 329 | </a>
|
---|
| 330 | <ul class="blockList">
|
---|
| 331 | <li class="blockList">
|
---|
| 332 | <h4>getDescription</h4>
|
---|
| 333 | <pre>public java.lang.String getDescription()</pre>
|
---|
| 334 | <div class="block">This is a convenience wrapper so that we don't have to fix all old agent
|
---|
| 335 | descriptions (these used to be in the xml file)</div>
|
---|
| 336 | <dl>
|
---|
| 337 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 338 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#getDescription--">getDescription</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 339 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
| 340 | <dd>a human-readable description for this party.</dd>
|
---|
| 341 | </dl>
|
---|
| 342 | </li>
|
---|
| 343 | </ul>
|
---|
| 344 | <a name="getProtocol--">
|
---|
| 345 | <!-- -->
|
---|
| 346 | </a>
|
---|
| 347 | <ul class="blockList">
|
---|
| 348 | <li class="blockList">
|
---|
| 349 | <h4>getProtocol</h4>
|
---|
| 350 | <pre>public final java.lang.Class<? extends <a href="../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a>> getProtocol()</pre>
|
---|
| 351 | <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../genius/core/parties/NegotiationParty.html#getProtocol--">NegotiationParty</a></code></span></div>
|
---|
| 352 | <div class="block">Get the protocol that this party supports.</div>
|
---|
| 353 | <dl>
|
---|
| 354 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 355 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#getProtocol--">getProtocol</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 356 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
| 357 | <dd>the actual supported <a href="../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol"><code>MultilateralProtocol</code></a>, usually
|
---|
| 358 | <a href="../../genius/core/protocol/StackedAlternatingOffersProtocol.html" title="class in genius.core.protocol"><code>StackedAlternatingOffersProtocol</code></a>.</dd>
|
---|
| 359 | </dl>
|
---|
| 360 | </li>
|
---|
| 361 | </ul>
|
---|
| 362 | <a name="negotiationEnded-genius.core.Bid-">
|
---|
| 363 | <!-- -->
|
---|
| 364 | </a>
|
---|
| 365 | <ul class="blockListLast">
|
---|
| 366 | <li class="blockList">
|
---|
| 367 | <h4>negotiationEnded</h4>
|
---|
| 368 | <pre>public final java.util.Map<java.lang.String,java.lang.String> negotiationEnded(<a href="../../genius/core/Bid.html" title="class in genius.core">Bid</a> acceptedBid)</pre>
|
---|
| 369 | <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../genius/core/parties/NegotiationParty.html#negotiationEnded-genius.core.Bid-">NegotiationParty</a></code></span></div>
|
---|
| 370 | <div class="block">This is called to inform the agent that the negotiation has been ended.
|
---|
| 371 | This allows the agent to record some final conclusions about the run.</div>
|
---|
| 372 | <dl>
|
---|
| 373 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
---|
| 374 | <dd><code><a href="../../genius/core/parties/NegotiationParty.html#negotiationEnded-genius.core.Bid-">negotiationEnded</a></code> in interface <code><a href="../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></dd>
|
---|
| 375 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
| 376 | <dd><code>acceptedBid</code> - the final accepted bid, or null if no agreement was reached.</dd>
|
---|
| 377 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
| 378 | <dd><code>Map</code> containing data to log for this agent. null is equal
|
---|
| 379 | to returning an empty HashMap. Typically, this info will be
|
---|
| 380 | logged by <a href="../../genius/core/xml/XmlWriteStream.html#write-java.lang.String-java.util.Map-"><code>XmlWriteStream.write(String, java.util.Map)</code></a> to
|
---|
| 381 | an XML file.</dd>
|
---|
| 382 | </dl>
|
---|
| 383 | </li>
|
---|
| 384 | </ul>
|
---|
| 385 | </li>
|
---|
| 386 | </ul>
|
---|
| 387 | </li>
|
---|
| 388 | </ul>
|
---|
| 389 | </div>
|
---|
| 390 | </div>
|
---|
| 391 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
| 392 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
| 393 | <div class="bottomNav"><a name="navbar.bottom">
|
---|
| 394 | <!-- -->
|
---|
| 395 | </a>
|
---|
| 396 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
---|
| 397 | <a name="navbar.bottom.firstrow">
|
---|
| 398 | <!-- -->
|
---|
| 399 | </a>
|
---|
| 400 | <ul class="navList" title="Navigation">
|
---|
| 401 | <li><a href="../../overview-summary.html">Overview</a></li>
|
---|
| 402 | <li><a href="package-summary.html">Package</a></li>
|
---|
| 403 | <li class="navBarCell1Rev">Class</li>
|
---|
| 404 | <li><a href="class-use/AgentAdapter.html">Use</a></li>
|
---|
| 405 | <li><a href="package-tree.html">Tree</a></li>
|
---|
| 406 | <li><a href="../../deprecated-list.html">Deprecated</a></li>
|
---|
| 407 | <li><a href="../../index-all.html">Index</a></li>
|
---|
| 408 | <li><a href="../../help-doc.html">Help</a></li>
|
---|
| 409 | </ul>
|
---|
| 410 | </div>
|
---|
| 411 | <div class="subNav">
|
---|
| 412 | <ul class="navList">
|
---|
| 413 | <li><a href="../../genius/core/Agent.html" title="class in genius.core"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
| 414 | <li><a href="../../genius/core/AgentID.html" title="class in genius.core"><span class="typeNameLink">Next Class</span></a></li>
|
---|
| 415 | </ul>
|
---|
| 416 | <ul class="navList">
|
---|
| 417 | <li><a href="../../index.html?genius/core/AgentAdapter.html" target="_top">Frames</a></li>
|
---|
| 418 | <li><a href="AgentAdapter.html" target="_top">No Frames</a></li>
|
---|
| 419 | </ul>
|
---|
| 420 | <ul class="navList" id="allclasses_navbar_bottom">
|
---|
| 421 | <li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
---|
| 422 | </ul>
|
---|
| 423 | <div>
|
---|
| 424 | <script type="text/javascript"><!--
|
---|
| 425 | allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
---|
| 426 | if(window==top) {
|
---|
| 427 | allClassesLink.style.display = "block";
|
---|
| 428 | }
|
---|
| 429 | else {
|
---|
| 430 | allClassesLink.style.display = "none";
|
---|
| 431 | }
|
---|
| 432 | //-->
|
---|
| 433 | </script>
|
---|
| 434 | </div>
|
---|
| 435 | <div>
|
---|
| 436 | <ul class="subNavList">
|
---|
| 437 | <li>Summary: </li>
|
---|
| 438 | <li>Nested | </li>
|
---|
| 439 | <li>Field | </li>
|
---|
| 440 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
| 441 | <li><a href="#method.summary">Method</a></li>
|
---|
| 442 | </ul>
|
---|
| 443 | <ul class="subNavList">
|
---|
| 444 | <li>Detail: </li>
|
---|
| 445 | <li>Field | </li>
|
---|
| 446 | <li><a href="#constructor.detail">Constr</a> | </li>
|
---|
| 447 | <li><a href="#method.detail">Method</a></li>
|
---|
| 448 | </ul>
|
---|
| 449 | </div>
|
---|
| 450 | <a name="skip.navbar.bottom">
|
---|
| 451 | <!-- -->
|
---|
| 452 | </a></div>
|
---|
| 453 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
| 454 | </body>
|
---|
| 455 | </html>
|
---|