doc/JavaDoc/ch/epfl/sdp/peakar/user/challenge/Challenge.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:42 CEST 2021 -->
<title>Challenge</title>
<meta name="date" content="2021-06-04">
<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="Challenge";
}
}
catch(err) {
}
//-->
var 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,"i13":6,"i14":6,"i15":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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>Prev Class</li>
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/ChallengeHandler.html" title="class in ch.epfl.sdp.peakar.user.challenge"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/challenge/Challenge.html" target="_top">Frames</a></li>
<li><a href="Challenge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </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">ch.epfl.sdp.peakar.user.challenge</div>
<h2 title="Interface Challenge" class="title">Interface Challenge</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/goal/PointsChallenge.html" title="class in ch.epfl.sdp.peakar.user.challenge.goal">PointsChallenge</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/goal/RemotePointsChallenge.html" title="class in ch.epfl.sdp.peakar.user.challenge.goal">RemotePointsChallenge</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Challenge</span></pre>
<div class="block">Interface of a basic challenge.</div>
</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"> </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>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#FOUNDER">FOUNDER</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#JOINED">JOINED</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#LOSER">LOSER</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#WINNER">WINNER</a></span></code> </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"> </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></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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getChallengeName--">getChallengeName</a></span>()</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.HashMap<java.lang.String,java.lang.Integer></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getChallengeRanking--">getChallengeRanking</a></span>()</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.HashMap<java.lang.String,java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getChallengeUserNames--">getChallengeUserNames</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.time.LocalDateTime</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getCreationDateTime--">getCreationDateTime</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getDurationInDays--">getDurationInDays</a></span>()</code> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.time.LocalDateTime</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getFinishDateTime--">getFinishDateTime</a></span>()</code> </td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getFounderID--">getFounderID</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>android.net.Uri</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getFounderUri--">getFounderUri</a></span>()</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getID--">getID</a></span>()</code>
<div class="block">Get the unique identifier of the challenge.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.time.LocalDateTime</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getStartDateTime--">getStartDateTime</a></span>()</code> </td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getStatus--">getStatus</a></span>()</code> </td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.List<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#getUsers--">getUsers</a></span>()</code>
<div class="block">Get the users who joined the challenge.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#join--">join</a></span>()</code>
<div class="block">Make the authenticated user join a new challenge.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#setFinishDateTime-java.time.LocalDateTime-">setFinishDateTime</a></span>(java.time.LocalDateTime finishDateTime)</code>
<div class="block">Set challenge finish date time</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#setStartDateTime-java.time.LocalDateTime-">setStartDateTime</a></span>(java.time.LocalDateTime startDateTime)</code>
<div class="block">Set challenge start time</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/Challenge.html#setStatus-ch.epfl.sdp.peakar.user.challenge.ChallengeStatus-">setStatus</a></span>(<a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/ChallengeStatus.html" title="enum in ch.epfl.sdp.peakar.user.challenge">ChallengeStatus</a> challengeStatus)</code>
<div class="block">Change challenge status</div>
</td>
</tr>
</table>
</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="FOUNDER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FOUNDER</h4>
<pre>static final java.lang.String FOUNDER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#ch.epfl.sdp.peakar.user.challenge.Challenge.FOUNDER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="JOINED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOINED</h4>
<pre>static final java.lang.String JOINED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#ch.epfl.sdp.peakar.user.challenge.Challenge.JOINED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WINNER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WINNER</h4>
<pre>static final java.lang.String WINNER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#ch.epfl.sdp.peakar.user.challenge.Challenge.WINNER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOSER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOSER</h4>
<pre>static final java.lang.String LOSER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#ch.epfl.sdp.peakar.user.challenge.Challenge.LOSER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre>java.lang.String getID()</pre>
<div class="block">Get the unique identifier of the challenge.</div>
</li>
</ul>
<a name="getChallengeRanking--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChallengeRanking</h4>
<pre>java.util.HashMap<java.lang.String,java.lang.Integer> getChallengeRanking()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>actual challenge ranking. Null if not applicable</dd>
</dl>
</li>
</ul>
<a name="getChallengeUserNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChallengeUserNames</h4>
<pre>java.util.HashMap<java.lang.String,java.lang.String> getChallengeUserNames()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>map between UID and username from users</dd>
</dl>
</li>
</ul>
<a name="getUsers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre>java.util.List<java.lang.String> getUsers()</pre>
<div class="block">Get the users who joined the challenge.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of IDs of the users who joined this challenge.</dd>
</dl>
</li>
</ul>
<a name="getFinishDateTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinishDateTime</h4>
<pre>java.time.LocalDateTime getFinishDateTime()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the challenge finishing Date</dd>
</dl>
</li>
</ul>
<a name="setFinishDateTime-java.time.LocalDateTime-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFinishDateTime</h4>
<pre>void setFinishDateTime(java.time.LocalDateTime finishDateTime)</pre>
<div class="block">Set challenge finish date time</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>finishDateTime</code> - challenge finish date time</dd>
</dl>
</li>
</ul>
<a name="getStartDateTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartDateTime</h4>
<pre>java.time.LocalDateTime getStartDateTime()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the challenge start Date</dd>
</dl>
</li>
</ul>
<a name="setStartDateTime-java.time.LocalDateTime-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartDateTime</h4>
<pre>void setStartDateTime(java.time.LocalDateTime startDateTime)</pre>
<div class="block">Set challenge start time</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>startDateTime</code> - challenge start time</dd>
</dl>
</li>
</ul>
<a name="getCreationDateTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationDateTime</h4>
<pre>java.time.LocalDateTime getCreationDateTime()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the challenge creation Date</dd>
</dl>
</li>
</ul>
<a name="getDurationInDays--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurationInDays</h4>
<pre>int getDurationInDays()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the challenge finishing Date</dd>
</dl>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre>int getStatus()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the challenge status</dd>
</dl>
</li>
</ul>
<a name="getChallengeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChallengeName</h4>
<pre>java.lang.String getChallengeName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>challenge Name</dd>
</dl>
</li>
</ul>
<a name="getFounderID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFounderID</h4>
<pre>java.lang.String getFounderID()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>challenge founder UID</dd>
</dl>
</li>
</ul>
<a name="getFounderUri--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFounderUri</h4>
<pre>android.net.Uri getFounderUri()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>challenge founder profile pic uri</dd>
</dl>
</li>
</ul>
<a name="setStatus-ch.epfl.sdp.peakar.user.challenge.ChallengeStatus-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatus</h4>
<pre>void setStatus(<a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/ChallengeStatus.html" title="enum in ch.epfl.sdp.peakar.user.challenge">ChallengeStatus</a> challengeStatus)</pre>
<div class="block">Change challenge status</div>
</li>
</ul>
<a name="join--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>join</h4>
<pre>void join()</pre>
<div class="block">Make the authenticated user join a new challenge.</div>
</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="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>Prev Class</li>
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/challenge/ChallengeHandler.html" title="class in ch.epfl.sdp.peakar.user.challenge"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/challenge/Challenge.html" target="_top">Frames</a></li>
<li><a href="Challenge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>