2021-01-17 17:38:52 +01:00
<!DOCTYPE HTML>
<!-- NewPage -->
< html lang = "en" >
< head >
2021-01-22 17:22:57 +01:00
<!-- Generated by javadoc (14.0.2) on Fri Jan 22 16:23:18 CET 2021 -->
2021-01-17 17:38:52 +01:00
< title > User (buisnesslogic 1.0-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
2021-01-22 17:22:57 +01:00
< meta name = "dc.created" content = "2021-01-22" >
2021-01-17 17:38:52 +01:00
< meta name = "description" content = "declaration: package: com.plannaplan.entities, class: User" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
< link rel = "stylesheet" type = "text/css" href = "../../../stylesheet.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../script-dir/jquery-ui.css" title = "Style" >
< script type = "text/javascript" src = "../../../script.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jszip/dist/jszip.min.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jszip-utils/dist/jszip-utils.min.js" > < / script >
<!-- [if IE]>
< script type = "text/javascript" src = "../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" src = "../../../script-dir/jquery-3.4.1.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jquery-ui.js" > < / script >
< / head >
< body class = "class-declaration" >
< script type = "text/javascript" > v a r d a t a = { " i 0 " : 1 0 , " i 1 " : 1 0 , " i 2 " : 1 0 , " i 3 " : 1 0 , " i 4 " : 1 0 , " i 5 " : 1 0 , " i 6 " : 1 0 , " i 7 " : 1 0 , " i 8 " : 1 0 , " i 9 " : 1 0 , " i 1 0 " : 1 0 , " i 1 1 " : 1 0 , " i 1 2 " : 1 0 , " i 1 3 " : 1 0 , " i 1 4 " : 1 0 , " i 1 5 " : 1 0 , " i 1 6 " : 1 0 , " i 1 7 " : 1 0 , " i 1 8 " : 1 0 , " i 1 9 " : 1 0 , " i 2 0 " : 1 0 } ;
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";
var pathtoroot = "../../../";
loadScripts(document, 'script');< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
< div class = "flexBox" >
< header role = "banner" class = "flexHeader" >
< nav role = "navigation" >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a id = "navbar.top" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a id = "navbar.top.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../index.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/User.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-all.html" > Index< / a > < / li >
< li > < a href = "../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< div class = "navListSearch" > < label for = "search" > SEARCH:< / label >
< input type = "text" id = "search" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset" value = "reset" disabled = "disabled" >
< / div >
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
< div class = "skipNav" > < a id = "skip.navbar.top" >
<!-- -->
< / a > < / div >
< / nav >
< / header >
< div class = "flexContent" >
< main role = "main" >
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.plannaplan.entities< / a > < / div >
< h1 title = "Class User" class = "title" > Class User< / h1 >
< / div >
< div class = "contentContainer" >
< div class = "inheritance" title = "Inheritance Tree" > java.lang.Object
< div class = "inheritance" > com.plannaplan.entities.User< / div >
< / div >
< section class = "description" >
< hr >
< pre > @Entity
public class < span class = "typeNameLabel" > User< / span >
extends java.lang.Object< / pre >
< div class = "block" > Entity of User grouping of state ssociated about
id,name,surname,email,role,token,tokenCreatedDate< / div >
< / section >
< section class = "summary" >
< ul class = "blockList" >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< li class = "blockList" >
< section class = "constructorSummary" > < a id = "constructor.summary" >
<!-- -->
< / a >
< h2 > Constructor Summary< / h2 >
< div class = "memberSummary" >
< table >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< thead >
< tr >
< th class = "colFirst" scope = "col" > Constructor< / th >
< th class = "colLast" scope = "col" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr class = "altColor" >
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E()" > User< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "rowColor" >
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles)" > User< / a > < / span > ​ (java.lang.String name,
java.lang.String surname,
java.lang.String mail,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "altColor" >
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles)" > User< / a > < / span > ​ (java.lang.String name,
java.lang.String surname,
java.lang.String mail,
java.lang.String usosId,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "rowColor" >
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles,java.lang.Integer)" > User< / a > < / span > ​ (java.lang.String name,
java.lang.String surname,
java.lang.String mail,
java.lang.String usosId,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role,
java.lang.Integer ranking)< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / li >
<!-- ========== METHOD SUMMARY =========== -->
< li class = "blockList" >
< section class = "methodSummary" > < a id = "method.summary" >
<!-- -->
< / a >
< h2 > Method Summary< / h2 >
< div class = "memberSummary" >
< div role = "tablist" aria-orientation = "horizontal" > < button role = "tab" aria-selected = "true" aria-controls = "memberSummary_tabpanel" tabindex = "0" onkeydown = "switchTab(event)" id = "t0" class = "activeTableTab" > All Methods< / button > < button role = "tab" aria-selected = "false" aria-controls = "memberSummary_tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" id = "t2" class = "tableTab" onclick = "show(2);" > Instance Methods< / button > < button role = "tab" aria-selected = "false" aria-controls = "memberSummary_tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" id = "t4" class = "tableTab" onclick = "show(8);" > Concrete Methods< / button > < / div >
< div id = "memberSummary_tabpanel" role = "tabpanel" >
< table aria-labelledby = "t0" >
< thead >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr class = "altColor" id = "i0" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#claimGroup(com.plannaplan.entities.Groups)" > claimGroup< / a > < / span > ​ (< a href = "Groups.html" title = "class in com.plannaplan.entities" > Groups< / a > group)< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "rowColor" id = "i1" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getEmail()" > getEmail< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > email getter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i2" >
< td class = "colFirst" > < code > java.lang.Long< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getId()" > getId< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > id getter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i3" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getName()" > getName< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > name setter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i4" >
< td class = "colFirst" > < code > java.lang.Integer< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getRanking()" > getRanking< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > Ranking points are [100;500].< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i5" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getRefreshToken()" > getRefreshToken< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "altColor" id = "i6" >
< td class = "colFirst" > < code > < a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getRole()" > getRole< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > user rolse getter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i7" >
< td class = "colFirst" > < code > java.util.Set< < a href = "Groups.html" title = "class in com.plannaplan.entities" > Groups< / a > > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getStudentRegisteredGrups()" > getStudentRegisteredGrups< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "altColor" id = "i8" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getSurname()" > getSurname< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > surname getter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i9" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getToken()" > getToken< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > token getter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i10" >
< td class = "colFirst" > < code > java.sql.Timestamp< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getTokenUsageDate()" > getTokenUsageDate< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > token usage getter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i11" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getUsosId()" > getUsosId< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > usos id getter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i12" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#isCredentialsNonExpired()" > isCredentialsNonExpired< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
< div class = "block" > it checks if given ammount of time passed since last token usage.< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i13" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#removeGroup(java.lang.Long)" > removeGroup< / a > < / span > ​ (java.lang.Long id)< / code > < / th >
< td class = "colLast" > < / td >
< / tr >
< tr class = "altColor" id = "i14" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setEmail(java.lang.String)" > setEmail< / a > < / span > ​ (java.lang.String email)< / code > < / th >
< td class = "colLast" >
< div class = "block" > email setter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i15" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setName(java.lang.String)" > setName< / a > < / span > ​ (java.lang.String name)< / code > < / th >
< td class = "colLast" >
< div class = "block" > name stter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i16" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setRanking(java.lang.Integer)" > setRanking< / a > < / span > ​ (java.lang.Integer ranking)< / code > < / th >
< td class = "colLast" >
< div class = "block" > Ranking points setter.< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i17" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setRole(com.plannaplan.types.UserRoles)" > setRole< / a > < / span > ​ (< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / code > < / th >
< td class = "colLast" >
< div class = "block" > user role setter< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i18" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setSurname(java.lang.String)" > setSurname< / a > < / span > ​ (java.lang.String surname)< / code > < / th >
< td class = "colLast" >
< div class = "block" > surname setter< / div >
< / td >
< / tr >
< tr class = "rowColor" id = "i19" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#setToken(java.lang.String)" > setToken< / a > < / span > ​ (java.lang.String token)< / code > < / th >
< td class = "colLast" >
< div class = "block" > token seter.< / div >
< / td >
< / tr >
< tr class = "altColor" id = "i20" >
< td class = "colFirst" > < code > void< / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#updateWithUsosData(com.plannaplan.models.UserApiResponse)" > updateWithUsosData< / a > < / span > ​ (< a href = "../models/UserApiResponse.html" title = "class in com.plannaplan.models" > UserApiResponse< / a > usosData)< / code > < / th >
< td class = "colLast" >
< div class = "block" > updates user entity with data got by UsosApiService::getUserData< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / div >
< div class = "inheritedList" >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< a id = "methods.inherited.from.class.java.lang.Object" >
<!-- -->
< / a > < code > clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait< / code > < / div >
< / section >
< / li >
< / ul >
< / section >
< section class = "details" >
< ul class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< li class = "blockList" >
< section class = "constructorDetails" > < a id = "constructor.detail" >
<!-- -->
< / a >
< h2 > Constructor Details< / h2 >
< ul class = "blockList" >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "<init>()" > User< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "memberName" > User< / span > ()< / div >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "<init>(java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles)" > User< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "memberName" > User< / span > ​ (< span class = "arguments" > java.lang.String name,
java.lang.String surname,
java.lang.String mail,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / span > < / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > name< / code > - name given to the user< / dd >
< dd > < code > surname< / code > - surname given to the user< / dd >
< dd > < code > mail< / code > - mail given to the user< / dd >
< dd > < code > role< / code > - user's role< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "<init>(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles)" > User< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "memberName" > User< / span > ​ (< span class = "arguments" > java.lang.String name,
java.lang.String surname,
java.lang.String mail,
java.lang.String usosId,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / span > < / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > name< / code > - name given to the user< / dd >
< dd > < code > surname< / code > - surname given to the user< / dd >
< dd > < code > mail< / code > - mail given to the user< / dd >
< dd > < code > usosId< / code > - id in the USOS system< / dd >
< dd > < code > role< / code > - user's role< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "<init>(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.plannaplan.types.UserRoles,java.lang.Integer)" > User< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "memberName" > User< / span > ​ (< span class = "arguments" > java.lang.String name,
java.lang.String surname,
java.lang.String mail,
java.lang.String usosId,
< a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role,
java.lang.Integer ranking)< / span > < / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > name< / code > - name given to the user< / dd >
< dd > < code > surname< / code > - surname given to the user< / dd >
< dd > < code > mail< / code > - mail given to the user< / dd >
< dd > < code > usosId< / code > - id in the USOS system< / dd >
< dd > < code > role< / code > - user's role< / dd >
< dd > < code > ranking< / code > - ranking points [100;500]. It's calculated by
gradesAvg*100*studiesYear< / dd >
< / dl >
< / section >
< / li >
< / ul >
< / section >
< / li >
<!-- ============ METHOD DETAIL ========== -->
< li class = "blockList" >
< section class = "methodDetails" > < a id = "method.detail" >
<!-- -->
< / a >
< h2 > Method Details< / h2 >
< ul class = "blockList" >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getStudentRegisteredGrups()" > getStudentRegisteredGrups< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.util.Set< < a href = "Groups.html" title = "class in com.plannaplan.entities" > Groups< / a > > < / span > < span class = "memberName" > getStudentRegisteredGrups< / span > ()< / div >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "removeGroup(java.lang.Long)" > removeGroup< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > removeGroup< / span > ​ (< span class = "arguments" > java.lang.Long id)< / span > < / div >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "claimGroup(com.plannaplan.entities.Groups)" > claimGroup< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > claimGroup< / span > ​ (< span class = "arguments" > < a href = "Groups.html" title = "class in com.plannaplan.entities" > Groups< / a > group)< / span > < / div >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getUsosId()" > getUsosId< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getUsosId< / span > ()< / div >
< div class = "block" > usos id getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > usosid< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getEmail()" > getEmail< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getEmail< / span > ()< / div >
< div class = "block" > email getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > mailof user< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setEmail(java.lang.String)" > setEmail< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setEmail< / span > ​ (< span class = "arguments" > java.lang.String email)< / span > < / div >
< div class = "block" > email setter< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > email< / code > - user email< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getTokenUsageDate()" > getTokenUsageDate< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.sql.Timestamp< / span > < span class = "memberName" > getTokenUsageDate< / span > ()< / div >
< div class = "block" > token usage getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Timestamp when token was used< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getToken()" > getToken< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getToken< / span > ()< / div >
< div class = "block" > token getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > user token< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getRefreshToken()" > getRefreshToken< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getRefreshToken< / span > ()< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > token needed to call refresh token after it expired< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setToken(java.lang.String)" > setToken< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setToken< / span > ​ (< span class = "arguments" > java.lang.String token)< / span > < / div >
< div class = "block" > token seter. Sets token and automaticly set time when was set< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > token< / code > - token to set< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getName()" > getName< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getName< / span > ()< / div >
< div class = "block" > name setter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > String user name< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getRole()" > getRole< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > < a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > < / span > < span class = "memberName" > getRole< / span > ()< / div >
< div class = "block" > user rolse getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > UserRoles of user< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setRole(com.plannaplan.types.UserRoles)" > setRole< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setRole< / span > ​ (< span class = "arguments" > < a href = "../types/UserRoles.html" title = "enum in com.plannaplan.types" > UserRoles< / a > role)< / span > < / div >
< div class = "block" > user role setter< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > role< / code > - to be set< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getSurname()" > getSurname< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.String< / span > < span class = "memberName" > getSurname< / span > ()< / div >
< div class = "block" > surname getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > string surname< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setSurname(java.lang.String)" > setSurname< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setSurname< / span > ​ (< span class = "arguments" > java.lang.String surname)< / span > < / div >
< div class = "block" > surname setter< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > surname< / code > - string to be set as surnames< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setName(java.lang.String)" > setName< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setName< / span > ​ (< span class = "arguments" > java.lang.String name)< / span > < / div >
< div class = "block" > name stter< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > name< / code > - stirng to be set as name< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getId()" > getId< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.Long< / span > < span class = "memberName" > getId< / span > ()< / div >
< div class = "block" > id getter< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > id in database< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "getRanking()" > getRanking< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > java.lang.Integer< / span > < span class = "memberName" > getRanking< / span > ()< / div >
< div class = "block" > Ranking points are [100;500]. It's calculated by gradesAvg*100*studiesYear< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > ranking points [100;500]< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "setRanking(java.lang.Integer)" > setRanking< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > setRanking< / span > ​ (< span class = "arguments" > java.lang.Integer ranking)< / span > < / div >
< div class = "block" > Ranking points setter. Ranking points are [100;500]. It's calculated by
gradesAvg*100*studiesYear< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > ranking< / code > - ranking points [100;500]< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "updateWithUsosData(com.plannaplan.models.UserApiResponse)" > updateWithUsosData< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > void< / span > < span class = "memberName" > updateWithUsosData< / span > ​ (< span class = "arguments" > < a href = "../models/UserApiResponse.html" title = "class in com.plannaplan.models" > UserApiResponse< / a > usosData)< / span > < / div >
< div class = "block" > updates user entity with data got by UsosApiService::getUserData< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > usosData< / code > - UserApiResponse model with needed data< / dd >
< / dl >
< / section >
< / li >
< li class = "blockList" >
< section class = "detail" >
< h3 > < a id = "isCredentialsNonExpired()" > isCredentialsNonExpired< / a > < / h3 >
< div class = "memberSignature" > < span class = "modifiers" > public< / span > < span class = "returnType" > boolean< / span > < span class = "memberName" > isCredentialsNonExpired< / span > ()< / div >
< div class = "block" > it checks if given ammount of time passed since last token usage. If not
retunr true and reset time otherwise return false and token won work anymore< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > boolena if credentials (token) is expired or not< / dd >
< / dl >
< / section >
< / li >
< / ul >
< / section >
< / li >
< / ul >
< / section >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
< / main >
< footer role = "contentinfo" >
< nav role = "navigation" >
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a id = "navbar.bottom" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a id = "navbar.bottom.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../index.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/User.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-all.html" > Index< / a > < / li >
< li > < a href = "../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< / div >
< a id = "skip.navbar.bottom" >
<!-- -->
< / a >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / nav >
< p class = "legalCopy" > < small > Copyright © 2021. All rights reserved.< / small > < / p >
< / footer >
< / div >
< / div >
< / body >
< / html >
