AISE
/
SEP-Board
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
SEP-Board/Dokumentation/Interation 2/JavaDoc/new_build/server/database/PollLib.html

418 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_111) on Mon Jun 19 14:04:41 CEST 2017 -->
<title>PollLib</title>
<meta name="date" content="2017-06-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PollLib";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PollLib.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../new_build/server/database/MessageLib.html" title="class in new_build.server.database"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../new_build/server/database/SQLConnection.html" title="class in new_build.server.database"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?new_build/server/database/PollLib.html" target="_top">Frames</a></li>
<li><a href="PollLib.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">new_build.server.database</div>
<h2 title="Class PollLib" class="title">Class PollLib</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>new_build.server.database.PollLib</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PollLib</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../new_build/server/database/SQLConnector.html" title="class in new_build.server.database">SQLConnector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#sqlConnector">sqlConnector</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#PollLib--">PollLib</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#addPoll-int-java.lang.String-java.sql.Date-">addPoll</a></span>(int&nbsp;groupID,
java.lang.String&nbsp;pollDescription,
java.sql.Date&nbsp;pollExpires)</code>
<div class="block">There is no pollID attribute, because it's the tables primary key
This Method adds a poll to the pollData table in the DB</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#addVote-int-int-int-">addVote</a></span>(int&nbsp;pollID,
int&nbsp;userID,
int&nbsp;vote)</code>
<div class="block">The boolean in Java is a bit, that's why
TODO Check if the poll even exists</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#getPollByID-int-">getPollByID</a></span>(int&nbsp;pollID)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#getPollIDs--">getPollIDs</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.LinkedList&lt;<a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#getPollsOfGroup-new_build.models.network_organisation.Group-">getPollsOfGroup</a></span>(<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>&nbsp;g)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int[][]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#getVotesByID-int-">getVotesByID</a></span>(int&nbsp;pollID)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/server/database/PollLib.html#insertChanges-new_build.models.common.polls.Poll-new_build.models.network_organisation.Group-">insertChanges</a></span>(<a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a>&nbsp;p,
<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>&nbsp;g)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="sqlConnector">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sqlConnector</h4>
<pre>private&nbsp;<a href="../../../new_build/server/database/SQLConnector.html" title="class in new_build.server.database">SQLConnector</a> sqlConnector</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PollLib--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PollLib</h4>
<pre>public&nbsp;PollLib()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPollIDs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPollIDs</h4>
<pre>public&nbsp;int[]&nbsp;getPollIDs()</pre>
</li>
</ul>
<a name="addPoll-int-java.lang.String-java.sql.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPoll</h4>
<pre>public&nbsp;void&nbsp;addPoll(int&nbsp;groupID,
java.lang.String&nbsp;pollDescription,
java.sql.Date&nbsp;pollExpires)</pre>
<div class="block">There is no pollID attribute, because it's the tables primary key
This Method adds a poll to the pollData table in the DB</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>groupID</code> - the group the poll is assigned to</dd>
<dd><code>pollDescription</code> - the name of the poll</dd>
<dd><code>pollExpires</code> - the date and time the poll expires</dd>
</dl>
</li>
</ul>
<a name="addVote-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addVote</h4>
<pre>public&nbsp;void&nbsp;addVote(int&nbsp;pollID,
int&nbsp;userID,
int&nbsp;vote)</pre>
<div class="block">The boolean in Java is a bit, that's why
TODO Check if the poll even exists</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pollID</code> - the poll you are voting for</dd>
<dd><code>userID</code> - the user that voted</dd>
<dd><code>vote</code> - your vote</dd>
</dl>
</li>
</ul>
<a name="getPollByID-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPollByID</h4>
<pre>public&nbsp;<a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a>&nbsp;getPollByID(int&nbsp;pollID)</pre>
</li>
</ul>
<a name="getVotesByID-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVotesByID</h4>
<pre>public&nbsp;int[][]&nbsp;getVotesByID(int&nbsp;pollID)</pre>
</li>
</ul>
<a name="getPollsOfGroup-new_build.models.network_organisation.Group-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPollsOfGroup</h4>
<pre>public&nbsp;java.util.LinkedList&lt;<a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a>&gt;&nbsp;getPollsOfGroup(<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>&nbsp;g)</pre>
</li>
</ul>
<a name="insertChanges-new_build.models.common.polls.Poll-new_build.models.network_organisation.Group-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>insertChanges</h4>
<pre>public&nbsp;void&nbsp;insertChanges(<a href="../../../new_build/models/common/polls/Poll.html" title="class in new_build.models.common.polls">Poll</a>&nbsp;p,
<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>&nbsp;g)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PollLib.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../new_build/server/database/MessageLib.html" title="class in new_build.server.database"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../new_build/server/database/SQLConnection.html" title="class in new_build.server.database"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?new_build/server/database/PollLib.html" target="_top">Frames</a></li>
<li><a href="PollLib.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink