dokumentacja-plannaplan/dokumentacja-backendu/businesslogic/allclasses-index.html

403 lines
18 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.2) on Sun Jan 17 17:36:43 CET 2021 -->
<title>All Classes (buisnesslogic 1.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-01-17">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<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="all-classes-index">
<script type="text/javascript">var data = {"i0":2,"i1":1,"i2":4,"i3":2,"i4":1,"i5":2,"i6":2,"i7":1,"i8":2,"i9":2,"i10":2,"i11":2,"i12":1,"i13":2,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":1,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":1,"i26":2,"i27":2,"i28":4,"i29":2,"i30":1,"i31":2,"i32":2,"i33":8,"i34":2,"i35":2,"i36":2,"i37":8,"i38":1,"i39":4,"i40":2,"i41":2,"i42":2,"i43":4};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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 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">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<div class="typeSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Interface Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Enum Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Exception Summary</button></div>
<div id="typeSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><a href="com/plannaplan/entities/AppConfig.html" title="class in com.plannaplan.entities">AppConfig</a></td>
<th class="colLast" scope="row">
<div class="block">entity that keeps app configurations</div>
</th>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><a href="com/plannaplan/repositories/AppConfigRepository.html" title="interface in com.plannaplan.repositories">AppConfigRepository</a></td>
<th class="colLast" scope="row">
<div class="block">Repository for app config</div>
</th>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><a href="com/plannaplan/types/AppState.html" title="enum in com.plannaplan.types">AppState</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><a href="com/plannaplan/entities/Assignment.html" title="class in com.plannaplan.entities">Assignment</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of Assignment grouping of state associated about group_id and
commision_id</div>
</th>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><a href="com/plannaplan/repositories/AssignmentRepository.html" title="interface in com.plannaplan.repositories">AssignmentRepository</a></td>
<th class="colLast" scope="row">
<div class="block">AssignmentRepository.getByCommision:
Return list of:
SELECT * FROM Assignment WHERE commision_id = i .</div>
</th>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><a href="com/plannaplan/services/AssignmentService.html" title="class in com.plannaplan.services">AssignmentService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of Assignment which can save assignments, diplay assignments, get
ammount of assigments.</div>
</th>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><a href="com/plannaplan/entities/Commision.html" title="class in com.plannaplan.entities">Commision</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of Commision grouping of state associated about commison and owner_id</div>
</th>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><a href="com/plannaplan/repositories/CommisionRepository.html" title="interface in com.plannaplan.repositories">CommisionRepository</a></td>
<th class="colLast" scope="row">
<div class="block">CommisionRepository.getUsers:
Return list of:
SELECT * FROM Commision WHERE owner_id = i .</div>
</th>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><a href="com/plannaplan/services/CommisionService.html" title="class in com.plannaplan.services">CommisionService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of CommisionService which can save commision, get user's commisions,
get newest user's commision, get ammount of commisions.</div>
</th>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><a href="com/plannaplan/models/ConfigData.html" title="class in com.plannaplan.models">ConfigData</a></td>
<th class="colLast" scope="row">
<div class="block">Config data copntainer to keep tours dates and stream of dasta to import</div>
</th>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><a href="com/plannaplan/services/ConfiguratorService.html" title="class in com.plannaplan.services">ConfiguratorService</a></td>
<th class="colLast" scope="row">
<div class="block">FileReader is used for reading xls file from input stream.</div>
</th>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><a href="com/plannaplan/entities/Course.html" title="class in com.plannaplan.entities">Course</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of Course grouping of state of course</div>
</th>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><a href="com/plannaplan/repositories/CourseRepository.html" title="interface in com.plannaplan.repositories">CourseRepository</a></td>
<th class="colLast" scope="row">
<div class="block">CourseRepository.findByName:
Return list of:
SELECT * FROM Course WHERE name = i .</div>
</th>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><a href="com/plannaplan/services/CourseService.html" title="class in com.plannaplan.services">CourseService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of CourseService which can get(Course By Name, All Courses, Courses
Ammount ), save, delete course.</div>
</th>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><a href="com/plannaplan/models/EmailAcceptedData.html" title="class in com.plannaplan.models">EmailAcceptedData</a></td>
<th class="colLast" scope="row">
<div class="block">Instance to keep data to send in mail about accepted courses results</div>
</th>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><a href="com/plannaplan/models/EmailExchangesData.html" title="class in com.plannaplan.models">EmailExchangesData</a></td>
<th class="colLast" scope="row">
<div class="block">Class to keepm data to be send after exchanges being accept</div>
</th>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><a href="com/plannaplan/services/EmailService.html" title="class in com.plannaplan.services">EmailService</a></td>
<th class="colLast" scope="row">
<div class="block">Service to send emails</div>
</th>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><a href="com/plannaplan/services/EventService.html" title="class in com.plannaplan.services">EventService</a></td>
<th class="colLast" scope="row">
<div class="block">Service to manage app events</div>
</th>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><a href="com/plannaplan/entities/Exchange.html" title="class in com.plannaplan.entities">Exchange</a></td>
<th class="colLast" scope="row">
<div class="block">Entity that keeps user exchange offer.</div>
</th>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><a href="com/plannaplan/repositories/ExchangeRepository.html" title="interface in com.plannaplan.repositories">ExchangeRepository</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><a href="com/plannaplan/services/ExchangeService.html" title="class in com.plannaplan.services">ExchangeService</a></td>
<th class="colLast" scope="row">
<div class="block">Service to manage Exchanges</div>
</th>
</tr>
<tr class="rowColor" id="i21">
<td class="colFirst"><a href="com/plannaplan/models/ExportData.html" title="class in com.plannaplan.models">ExportData</a></td>
<th class="colLast" scope="row">
<div class="block">Container to keep data to export</div>
</th>
</tr>
<tr class="altColor" id="i22">
<td class="colFirst"><a href="com/plannaplan/models/FileData.html" title="class in com.plannaplan.models">FileData</a></td>
<th class="colLast" scope="row">
<div class="block">Wrapper for data readed from file</div>
</th>
</tr>
<tr class="rowColor" id="i23">
<td class="colFirst"><a href="com/plannaplan/configutils/FileReader.html" title="class in com.plannaplan.configutils">FileReader</a></td>
<th class="colLast" scope="row">
<div class="block">FileReader is used for reading xls file from input stream.</div>
</th>
</tr>
<tr class="altColor" id="i24">
<td class="colFirst"><a href="com/plannaplan/configutils/FileToDatabaseMigrator.html" title="class in com.plannaplan.configutils">FileToDatabaseMigrator</a></td>
<th class="colLast" scope="row">
<div class="block">FileToDatabaseMigrator is used for migrate data from file (it reads line by
line) and push it into database</div>
</th>
</tr>
<tr class="rowColor" id="i25">
<td class="colFirst"><a href="com/plannaplan/repositories/GroupRepository.html" title="interface in com.plannaplan.repositories">GroupRepository</a></td>
<th class="colLast" scope="row">
<div class="block">GroupRepository.find:
Return list of:
SELECT * FROM Groups WHERE time = i AND room = j AND capacity = k .</div>
</th>
</tr>
<tr class="altColor" id="i26">
<td class="colFirst"><a href="com/plannaplan/entities/Groups.html" title="class in com.plannaplan.entities">Groups</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of Groups grouping of state ssociated about
course,time,room,capacity,type,day</div>
</th>
</tr>
<tr class="rowColor" id="i27">
<td class="colFirst"><a href="com/plannaplan/services/GroupService.html" title="class in com.plannaplan.services">GroupService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of GroupService which can find(optional), get(By Course, Groups
Ammount, Group By Id, find Not Existing Group), save, delete group.</div>
</th>
</tr>
<tr class="altColor" id="i28">
<td class="colFirst"><a href="com/plannaplan/types/GroupType.html" title="enum in com.plannaplan.types">GroupType</a></td>
<th class="colLast" scope="row">
<div class="block">GroupType contains types: LECTURE, CLASS, LAB, SEMINAR, CONSERVATORY, PRATICE</div>
</th>
</tr>
<tr class="rowColor" id="i29">
<td class="colFirst"><a href="com/plannaplan/entities/Lecturer.html" title="class in com.plannaplan.entities">Lecturer</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of Lecturer grouping of state ssociated about id,title,name,surname</div>
</th>
</tr>
<tr class="altColor" id="i30">
<td class="colFirst"><a href="com/plannaplan/repositories/LecturerRepository.html" title="interface in com.plannaplan.repositories">LecturerRepository</a></td>
<th class="colLast" scope="row">
<div class="block">LecturerRepository.find:
Return list of:
SELECT * FROM Lecturer WHERE title = i AND name = j AND surname = k.</div>
</th>
</tr>
<tr class="rowColor" id="i31">
<td class="colFirst"><a href="com/plannaplan/services/LecturerService.html" title="class in com.plannaplan.services">LecturerService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of LecturerService which can get(Lecturer, Lecturers Ammount), save, delete lecturers.</div>
</th>
</tr>
<tr class="altColor" id="i32">
<td class="colFirst"><a href="com/plannaplan/models/MatchData.html" title="class in com.plannaplan.models">MatchData</a></td>
<th class="colLast" scope="row">
<div class="block">Match of users Exchange's to be performed</div>
</th>
</tr>
<tr class="rowColor" id="i33">
<td class="colFirst"><a href="com/plannaplan/exceptions/TokenExpiredException.html" title="class in com.plannaplan.exceptions">TokenExpiredException</a></td>
<th class="colLast" scope="row">
<div class="block">Excepction to be thrown when provided token is expired</div>
</th>
</tr>
<tr class="altColor" id="i34">
<td class="colFirst"><a href="com/plannaplan/models/TourData.html" title="class in com.plannaplan.models">TourData</a></td>
<th class="colLast" scope="row">
<div class="block">Container for Tours dates</div>
</th>
</tr>
<tr class="rowColor" id="i35">
<td class="colFirst"><a href="com/plannaplan/entities/User.html" title="class in com.plannaplan.entities">User</a></td>
<th class="colLast" scope="row">
<div class="block">Entity of User grouping of state ssociated about
id,name,surname,email,role,token,tokenCreatedDate</div>
</th>
</tr>
<tr class="altColor" id="i36">
<td class="colFirst"><a href="com/plannaplan/models/UserApiResponse.html" title="class in com.plannaplan.models">UserApiResponse</a></td>
<th class="colLast" scope="row">
<div class="block">Model to keep data from /services/users/user response called in
UsosApiService</div>
</th>
</tr>
<tr class="rowColor" id="i37">
<td class="colFirst"><a href="com/plannaplan/exceptions/UserNotFoundException.html" title="class in com.plannaplan.exceptions">UserNotFoundException</a></td>
<th class="colLast" scope="row">
<div class="block">Exception to be thrown when provided user does not exist in database</div>
</th>
</tr>
<tr class="altColor" id="i38">
<td class="colFirst"><a href="com/plannaplan/repositories/UserRepository.html" title="interface in com.plannaplan.repositories">UserRepository</a></td>
<th class="colLast" scope="row">
<div class="block">UserRepository.getByAuthority: Return list of: SELECT * FROM User WHERE email
= i.</div>
</th>
</tr>
<tr class="rowColor" id="i39">
<td class="colFirst"><a href="com/plannaplan/types/UserRoles.html" title="enum in com.plannaplan.types">UserRoles</a></td>
<th class="colLast" scope="row">
<div class="block">UserRoles contains types: STUDENT, DEANERY, ADMIN, TEST_USER</div>
</th>
</tr>
<tr class="altColor" id="i40">
<td class="colFirst"><a href="com/plannaplan/services/UserService.html" title="class in com.plannaplan.services">UserService</a></td>
<th class="colLast" scope="row">
<div class="block">Service of UserService which can get(By Email), login, save user.</div>
</th>
</tr>
<tr class="rowColor" id="i41">
<td class="colFirst"><a href="com/plannaplan/services/UsosApiService.html" title="class in com.plannaplan.services">UsosApiService</a></td>
<th class="colLast" scope="row">
<div class="block">service to call usos api endpoints</div>
</th>
</tr>
<tr class="altColor" id="i42">
<td class="colFirst"><a href="com/plannaplan/api/UsosOauth1Service.html" title="class in com.plannaplan.api">UsosOauth1Service</a></td>
<th class="colLast" scope="row">
<div class="block">singleton class to sign usos api requests with oauth</div>
</th>
</tr>
<tr class="rowColor" id="i43">
<td class="colFirst"><a href="com/plannaplan/types/WeekDay.html" title="enum in com.plannaplan.types">WeekDay</a></td>
<th class="colLast" scope="row">
<div class="block">WeekDay contains types: MONDAY(0), TUESDAY(1), WEDNESDAY(2), THURSDAY(3), FRIDAY(4), SATURDAY(5), SUNDAY(6).</div>
</th>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>