y0rune/dokumentacja-plannaplan
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
b533d91e88
dokumentacja-plannaplan/dokumentacja-backendu/businesslogic/com/plannaplan/services/CommisionService.html

337 lines
14 KiB
HTML
Raw Normal View History

Added businesslogic docs Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-17 17:38:52 +01:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
Added businesslogic Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-18 16:36:20 +01:00
<!-- Generated by javadoc (14.0.2) on Mon Jan 18 16:34:08 CET 2021 -->
Added businesslogic docs Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-17 17:38:52 +01:00
<title>CommisionService (buisnesslogic 1.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Added businesslogic Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-18 16:36:20 +01:00
<meta name="dc.created" content="2021-01-18">
Added businesslogic docs Signed-off-by: Marcin Woźniak <y0rune@aol.com>
2021-01-17 17:38:52 +01:00
<meta name="description" content="declaration: package: com.plannaplan.services, class: CommisionService">
<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">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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/CommisionService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">com.plannaplan.services</a></div>
<h1 title="Class CommisionService" class="title">Class CommisionService</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">com.plannaplan.services.CommisionService</div>
</div>
<section class="description">
<hr>
<pre>@Service
public class <span class="typeNameLabel">CommisionService</span>
extends java.lang.Object</pre>
<div class="block">Service of CommisionService which can save commision, get user's commisions,
get newest user's commision, get ammount of commisions.</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">&nbsp;</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()">CommisionService</a></span>()</code></th>
<td class="colLast">&nbsp;</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>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommisionsAmmount()">getCommisionsAmmount</a></span>()</code></th>
<td class="colLast">
<div class="block">get ammpounts of commisions</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>java.util.List&lt;<a href="../models/ExportData.html" title="class in com.plannaplan.models">ExportData</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExportData()">getExportData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNewestCommision(com.plannaplan.entities.User)">getNewestCommision</a></span>&#8203;(<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">get newest commision ov given user</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>java.util.List&lt;<a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsersCommisions(com.plannaplan.entities.User)">getUsersCommisions</a></span>&#8203;(<a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">gets user commisions</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#save(com.plannaplan.entities.Commision)">save</a></span>&#8203;(<a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&nbsp;commision)</code></th>
<td class="colLast">
<div class="block">save to database commision.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;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="&lt;init&gt;()">CommisionService</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">CommisionService</span>()</div>
</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="save(com.plannaplan.entities.Commision)">save</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a></span>&nbsp;<span class="memberName">save</span>&#8203;(<span class="arguments"><a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&nbsp;commision)</span></div>
<div class="block">save to database commision. It also checks for missing assignments from
previous commision (you can not get rid of accepted assignment)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>commision</code> - to save to db</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Commision instance with id from database</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getUsersCommisions(com.plannaplan.entities.User)">getUsersCommisions</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.util.List&lt;<a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&gt;</span>&nbsp;<span class="memberName">getUsersCommisions</span>&#8203;(<span class="arguments"><a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&nbsp;user)</span></div>
<div class="block">gets user commisions</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - owner of commisions</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of user commisions</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getNewestCommision(com.plannaplan.entities.User)">getNewestCommision</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.util.Optional&lt;<a href="../entities/Commision.html" title="class in com.plannaplan.entities">Commision</a>&gt;</span>&nbsp;<span class="memberName">getNewestCommision</span>&#8203;(<span class="arguments"><a href="../entities/User.html" title="class in com.plannaplan.entities">User</a>&nbsp;user)</span></div>
<div class="block">get newest commision ov given user</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - owener of commision we attemp to get</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>optional if commition was found</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getCommisionsAmmount()">getCommisionsAmmount</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">long</span>&nbsp;<span class="memberName">getCommisionsAmmount</span>()</div>
<div class="block">get ammpounts of commisions</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long - ammounts of commisions (all even from history, not only
cutrrent one)</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getExportData()">getExportData</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">java.util.List&lt;<a href="../models/ExportData.html" title="class in com.plannaplan.models">ExportData</a>&gt;</span>&nbsp;<span class="memberName">getExportData</span>()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of ExportData inmstancces keeping data to exprt to file</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/CommisionService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink