source: javadoc/genius/core/boaframework/SessionData.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: 13.1 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>SessionData (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="SessionData (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/SessionData.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/boaframework/OutcomeTuple.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/boaframework/SharedAgentState.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/boaframework/SessionData.html" target="_top">Frames</a></li>
57<li><a href="SessionData.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.boaframework</div>
96<h2 title="Class SessionData" class="title">Class SessionData</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.boaframework.SessionData</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>java.io.Serializable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">SessionData</span>
117extends java.lang.Object
118implements java.io.Serializable</pre>
119<div class="block">In a BOAagent each component should be able to store data to be used in the next
120 negotiation session. Unfortunately, the ANAC2013 implementation only allows us to
121 store a single object. Therefore, this object packs the object of each of the three
122 BOA components (bidding strategy, etc.) together as a single object.</div>
123<dl>
124<dt><span class="simpleTagLabel">Author:</span></dt>
125<dd>Mark Hendrikx</dd>
126<dt><span class="seeLabel">See Also:</span></dt>
127<dd><a href="../../../serialized-form.html#genius.core.boaframework.SessionData">Serialized Form</a></dd>
128</dl>
129</li>
130</ul>
131</div>
132<div class="summary">
133<ul class="blockList">
134<li class="blockList">
135<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136<ul class="blockList">
137<li class="blockList"><a name="constructor.summary">
138<!-- -->
139</a>
140<h3>Constructor Summary</h3>
141<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
142<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
143<tr>
144<th class="colOne" scope="col">Constructor and Description</th>
145</tr>
146<tr class="altColor">
147<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#SessionData--">SessionData</a></span>()</code>&nbsp;</td>
148</tr>
149</table>
150</li>
151</ul>
152<!-- ========== METHOD SUMMARY =========== -->
153<ul class="blockList">
154<li class="blockList"><a name="method.summary">
155<!-- -->
156</a>
157<h3>Method Summary</h3>
158<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
159<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>
160<tr>
161<th class="colFirst" scope="col">Modifier and Type</th>
162<th class="colLast" scope="col">Method and Description</th>
163</tr>
164<tr id="i0" class="altColor">
165<td class="colFirst"><code>void</code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#changesCommitted--">changesCommitted</a></span>()</code>
167<div class="block">Sets that all changes have been processed.</div>
168</td>
169</tr>
170<tr id="i1" class="rowColor">
171<td class="colFirst"><code>java.io.Serializable</code></td>
172<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#getData-genius.core.boaframework.BoaType-">getData</a></span>(<a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type)</code>
173<div class="block">Returns the data stored by the given BOA component.</div>
174</td>
175</tr>
176<tr id="i2" class="altColor">
177<td class="colFirst"><code>boolean</code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#isChanged--">isChanged</a></span>()</code>&nbsp;</td>
179</tr>
180<tr id="i3" class="rowColor">
181<td class="colFirst"><code>boolean</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#isEmpty--">isEmpty</a></span>()</code>&nbsp;</td>
183</tr>
184<tr id="i4" class="altColor">
185<td class="colFirst"><code>void</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/SessionData.html#setData-genius.core.boaframework.BoaType-java.io.Serializable-">setData</a></span>(<a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;component,
187 java.io.Serializable&nbsp;data)</code>
188<div class="block">Method used to set the data to be saved by a BOA component.</div>
189</td>
190</tr>
191</table>
192<ul class="blockList">
193<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
194<!-- -->
195</a>
196<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
197<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
198</ul>
199</li>
200</ul>
201</li>
202</ul>
203</div>
204<div class="details">
205<ul class="blockList">
206<li class="blockList">
207<!-- ========= CONSTRUCTOR DETAIL ======== -->
208<ul class="blockList">
209<li class="blockList"><a name="constructor.detail">
210<!-- -->
211</a>
212<h3>Constructor Detail</h3>
213<a name="SessionData--">
214<!-- -->
215</a>
216<ul class="blockListLast">
217<li class="blockList">
218<h4>SessionData</h4>
219<pre>public&nbsp;SessionData()</pre>
220</li>
221</ul>
222</li>
223</ul>
224<!-- ============ METHOD DETAIL ========== -->
225<ul class="blockList">
226<li class="blockList"><a name="method.detail">
227<!-- -->
228</a>
229<h3>Method Detail</h3>
230<a name="getData-genius.core.boaframework.BoaType-">
231<!-- -->
232</a>
233<ul class="blockList">
234<li class="blockList">
235<h4>getData</h4>
236<pre>public&nbsp;java.io.Serializable&nbsp;getData(<a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type)</pre>
237<div class="block">Returns the data stored by the given BOA component.</div>
238<dl>
239<dt><span class="paramLabel">Parameters:</span></dt>
240<dd><code>type</code> - of the BOA component.</dd>
241<dt><span class="returnLabel">Returns:</span></dt>
242<dd>component saved by this BOA component, null is no object saved.</dd>
243</dl>
244</li>
245</ul>
246<a name="setData-genius.core.boaframework.BoaType-java.io.Serializable-">
247<!-- -->
248</a>
249<ul class="blockList">
250<li class="blockList">
251<h4>setData</h4>
252<pre>public&nbsp;void&nbsp;setData(<a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;component,
253 java.io.Serializable&nbsp;data)</pre>
254<div class="block">Method used to set the data to be saved by a BOA component.
255 This method should not be called directly, use the storeData()
256 and loadDate() of the component instead.</div>
257<dl>
258<dt><span class="paramLabel">Parameters:</span></dt>
259<dd><code>component</code> - from which the data is to be saved.</dd>
260<dd><code>data</code> - to be saved.</dd>
261</dl>
262</li>
263</ul>
264<a name="isEmpty--">
265<!-- -->
266</a>
267<ul class="blockList">
268<li class="blockList">
269<h4>isEmpty</h4>
270<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
271<dl>
272<dt><span class="returnLabel">Returns:</span></dt>
273<dd>true if save was saved by a component.</dd>
274</dl>
275</li>
276</ul>
277<a name="isChanged--">
278<!-- -->
279</a>
280<ul class="blockList">
281<li class="blockList">
282<h4>isChanged</h4>
283<pre>public&nbsp;boolean&nbsp;isChanged()</pre>
284<dl>
285<dt><span class="returnLabel">Returns:</span></dt>
286<dd>true if object was after its creation.</dd>
287</dl>
288</li>
289</ul>
290<a name="changesCommitted--">
291<!-- -->
292</a>
293<ul class="blockListLast">
294<li class="blockList">
295<h4>changesCommitted</h4>
296<pre>public&nbsp;void&nbsp;changesCommitted()</pre>
297<div class="block">Sets that all changes have been processed.</div>
298</li>
299</ul>
300</li>
301</ul>
302</li>
303</ul>
304</div>
305</div>
306<!-- ========= END OF CLASS DATA ========= -->
307<!-- ======= START OF BOTTOM NAVBAR ====== -->
308<div class="bottomNav"><a name="navbar.bottom">
309<!-- -->
310</a>
311<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
312<a name="navbar.bottom.firstrow">
313<!-- -->
314</a>
315<ul class="navList" title="Navigation">
316<li><a href="../../../overview-summary.html">Overview</a></li>
317<li><a href="package-summary.html">Package</a></li>
318<li class="navBarCell1Rev">Class</li>
319<li><a href="class-use/SessionData.html">Use</a></li>
320<li><a href="package-tree.html">Tree</a></li>
321<li><a href="../../../deprecated-list.html">Deprecated</a></li>
322<li><a href="../../../index-all.html">Index</a></li>
323<li><a href="../../../help-doc.html">Help</a></li>
324</ul>
325</div>
326<div class="subNav">
327<ul class="navList">
328<li><a href="../../../genius/core/boaframework/OutcomeTuple.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
329<li><a href="../../../genius/core/boaframework/SharedAgentState.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
330</ul>
331<ul class="navList">
332<li><a href="../../../index.html?genius/core/boaframework/SessionData.html" target="_top">Frames</a></li>
333<li><a href="SessionData.html" target="_top">No&nbsp;Frames</a></li>
334</ul>
335<ul class="navList" id="allclasses_navbar_bottom">
336<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
337</ul>
338<div>
339<script type="text/javascript"><!--
340 allClassesLink = document.getElementById("allclasses_navbar_bottom");
341 if(window==top) {
342 allClassesLink.style.display = "block";
343 }
344 else {
345 allClassesLink.style.display = "none";
346 }
347 //-->
348</script>
349</div>
350<div>
351<ul class="subNavList">
352<li>Summary:&nbsp;</li>
353<li>Nested&nbsp;|&nbsp;</li>
354<li>Field&nbsp;|&nbsp;</li>
355<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
356<li><a href="#method.summary">Method</a></li>
357</ul>
358<ul class="subNavList">
359<li>Detail:&nbsp;</li>
360<li>Field&nbsp;|&nbsp;</li>
361<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
362<li><a href="#method.detail">Method</a></li>
363</ul>
364</div>
365<a name="skip.navbar.bottom">
366<!-- -->
367</a></div>
368<!-- ======== END OF BOTTOM NAVBAR ======= -->
369</body>
370</html>
Note: See TracBrowser for help on using the repository browser.