bgabriel998/SoftwareDevProject

View on GitHub
doc/JavaDoc/ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html

Summary

Maintainability
Test Coverage
<!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:41 CEST 2021 -->
<title>RemoteOtherAccount</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="RemoteOtherAccount";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteAuthAccount.html" title="class in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" target="_top">Frames</a></li>
<li><a href="RemoteOtherAccount.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>Constr&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>Constr&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">ch.epfl.sdp.peakar.user.services</div>
<h2 title="Class RemoteOtherAccount" class="title">Class RemoteOtherAccount</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html" title="class in ch.epfl.sdp.peakar.user.services">ch.epfl.sdp.peakar.user.services.Account</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">ch.epfl.sdp.peakar.user.services.OtherAccount</a></li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.user.services.RemoteOtherAccount</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteResource.html" title="interface in ch.epfl.sdp.peakar.general.remote">RemoteResource</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RemoteOtherAccount</span>
extends <a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">OtherAccount</a>
implements <a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteResource.html" title="interface in ch.epfl.sdp.peakar.general.remote">RemoteResource</a></pre>
<div class="block">This class extends Account implementing RemoteResource in order to handle DB interaction.</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">&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>protected static java.util.Hashtable&lt;java.lang.String,<a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html#loadedAccounts">loadedAccounts</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.ch.epfl.sdp.peakar.user.services.Account">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;ch.epfl.sdp.peakar.user.services.<a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html" title="class in ch.epfl.sdp.peakar.user.services">Account</a></h3>
<code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#accountData">accountData</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#NAME_MAX_LENGTH">NAME_MAX_LENGTH</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#NAME_MIN_LENGTH">NAME_MIN_LENGTH</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#USERNAME_BEFORE_REGISTRATION">USERNAME_BEFORE_REGISTRATION</a></code></li>
</ul>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html#getInstance-java.lang.String-">getInstance</a></span>(java.lang.String&nbsp;userID)</code>
<div class="block">Get a Firebase account instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html#getNewInstance-java.lang.String-">getNewInstance</a></span>(java.lang.String&nbsp;userID)</code>
<div class="block">Get a Firebase account instance.</div>
</td>
</tr>
<tr id="i2" 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/services/RemoteOtherAccount.html#getUserID--">getUserID</a></span>()</code>
<div class="block">Get the ID of the user.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html#retrieveData--">retrieveData</a></span>()</code>
<div class="block">Retrieve data from the remote resource.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ch.epfl.sdp.peakar.user.services.OtherAccount">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;ch.epfl.sdp.peakar.user.services.<a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">OtherAccount</a></h3>
<code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html#getPhotoUrl--">getPhotoUrl</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ch.epfl.sdp.peakar.user.services.Account">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;ch.epfl.sdp.peakar.user.services.<a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html" title="class in ch.epfl.sdp.peakar.user.services">Account</a></h3>
<code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#checkUsernameValidity-java.lang.String-">checkUsernameValidity</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getChallenges--">getChallenges</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getDiscoveredCountryHighPoint--">getDiscoveredCountryHighPoint</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getDiscoveredCountryHighPointNames--">getDiscoveredCountryHighPointNames</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getDiscoveredPeakHeights--">getDiscoveredPeakHeights</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getDiscoveredPeaks--">getDiscoveredPeaks</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getFriends--">getFriends</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getScore--">getScore</a>, <a href="../../../../../../ch/epfl/sdp/peakar/user/services/Account.html#getUsername--">getUsername</a></code></li>
</ul>
<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="loadedAccounts">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadedAccounts</h4>
<pre>protected static final&nbsp;java.util.Hashtable&lt;java.lang.String,<a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a>&gt; loadedAccounts</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getInstance-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a>&nbsp;getInstance(java.lang.String&nbsp;userID)</pre>
<div class="block">Get a Firebase account instance.
 WARNING: you SHOULD NOT call this method. To get an account you should call <code>OtherAccount.getInstance(String authID)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userID</code> - id of the user.</dd>
</dl>
</li>
</ul>
<a name="getNewInstance-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewInstance</h4>
<pre>public static&nbsp;<a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">RemoteOtherAccount</a>&nbsp;getNewInstance(java.lang.String&nbsp;userID)</pre>
<div class="block">Get a Firebase account instance.
 WARNING: you SHOULD NOT call this method. To get an account you should call <code>OtherAccount.getInstance(String authID)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userID</code> - id of the user.</dd>
</dl>
</li>
</ul>
<a name="getUserID--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserID</h4>
<pre>public&nbsp;java.lang.String&nbsp;getUserID()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html#getUserID--">OtherAccount</a></code></span></div>
<div class="block">Get the ID of the user.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html#getUserID--">getUserID</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/OtherAccount.html" title="class in ch.epfl.sdp.peakar.user.services">OtherAccount</a></code></dd>
</dl>
</li>
</ul>
<a name="retrieveData--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>retrieveData</h4>
<pre>public&nbsp;<a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a>&nbsp;retrieveData()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteResource.html#retrieveData--">RemoteResource</a></code></span></div>
<div class="block">Retrieve data from the remote resource.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteResource.html#retrieveData--">retrieveData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteResource.html" title="interface in ch.epfl.sdp.peakar.general.remote">RemoteResource</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Outcome of the retrieval.</dd>
</dl>
</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><a href="../../../../../../ch/epfl/sdp/peakar/user/services/RemoteAuthAccount.html" title="class in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/services/RemoteOtherAccount.html" target="_top">Frames</a></li>
<li><a href="RemoteOtherAccount.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>Constr&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>Constr&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>