forked from bikol/DPRI_doc_20-21
384 lines
19 KiB
HTML
384 lines
19 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (15) on Sun Jan 24 17:03:02 CET 2021 -->
|
|
<title>CommisionController (restservice 1.0-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2021-01-24">
|
|
<meta name="description" content="declaration: package: com.plannaplan.controllers, class: CommisionController">
|
|
<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.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "alt-color";
|
|
var rowColor = "row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar.top">
|
|
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/CommisionController.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="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<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="nav-list-search"><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 ========= -->
|
|
<span class="skip-nav" id="skip.navbar.top">
|
|
<!-- -->
|
|
</span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.plannaplan.controllers</a></div>
|
|
<h1 title="Class CommisionController" class="title">Class CommisionController</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance"><a href="TokenBasedController.html" title="class in com.plannaplan.controllers">com.plannaplan.controllers.TokenBasedController</a>
|
|
<div class="inheritance">com.plannaplan.controllers.CommisionController</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<hr>
|
|
<pre>@RestController
|
|
@CrossOrigin
|
|
@RequestMapping("/api/v1/commisions")
|
|
public class <span class="type-name-label">CommisionController</span>
|
|
extends <a href="TokenBasedController.html" title="class in com.plannaplan.controllers">TokenBasedController</a></pre>
|
|
<div class="block">Rest controller to Commision and Assignment related endpoints. More detailed
|
|
api docs is available via swagger</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field.summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="inherited-list">
|
|
<h3 id="fields.inherited.from.class.com.plannaplan.controllers.TokenBasedController">Fields inherited from class com.plannaplan.controllers.<a href="TokenBasedController.html" title="class in com.plannaplan.controllers">TokenBasedController</a></h3>
|
|
<code><a href="TokenBasedController.html#userService">userService</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor.summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="member-summary">
|
|
<table class="summary-table">
|
|
<caption><span>Constructors</span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Constructor</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color">
|
|
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E()">CommisionController</a></span>()</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method.summary">
|
|
<h2>Method Summary</h2>
|
|
<div class="member-summary" id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<table class="summary-table" aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
|
<th class="col-second" scope="col">Method</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color" id="i0">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.lang.String></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addCommision(java.util.List,java.lang.Long)">addCommision</a></span>​(java.util.List<java.lang.Long> groups,
|
|
java.lang.Long userId)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color" id="i1">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.util.List<? extends <a href="../responses/models/CommisionResponse.html" title="class in com.plannaplan.responses.models">CommisionResponse</a>>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAlCommisions(java.lang.Boolean,java.lang.Boolean)">getAlCommisions</a></span>​(java.lang.Boolean groups,
|
|
java.lang.Boolean extraInfo)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color" id="i2">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentDetailedResponse.html" title="class in com.plannaplan.responses.models">AssignmentDetailedResponse</a>>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAllAssignmets()">getAllAssignmets</a></span>()</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color" id="i3">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.util.List<? extends <a href="../responses/models/CommisionResponse.html" title="class in com.plannaplan.responses.models">CommisionResponse</a>>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getCommision(java.lang.Long,java.lang.Boolean)">getCommision</a></span>​(java.lang.Long userId,
|
|
java.lang.Boolean groups)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color" id="i4">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentResponse.html" title="class in com.plannaplan.responses.models">AssignmentResponse</a>>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getCurrentAssignments()">getCurrentAssignments</a></span>()</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color" id="i5">
|
|
<td class="col-first"><code>org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentResponse.html" title="class in com.plannaplan.responses.models">AssignmentResponse</a>>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getCurrentAssignmentsDeanery(java.lang.Long)">getCurrentAssignmentsDeanery</a></span>​(java.lang.Long userId)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color" id="i6">
|
|
<td class="col-first"><code>void</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getFile(javax.servlet.http.HttpServletResponse)">getFile</a></span>​(javax.servlet.http.HttpServletResponse response)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.com.plannaplan.controllers.TokenBasedController">Methods inherited from class com.plannaplan.controllers.<a href="TokenBasedController.html" title="class in com.plannaplan.controllers">TokenBasedController</a></h3>
|
|
<code><a href="TokenBasedController.html#getCurrentUser()">getCurrentUser</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor.detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>CommisionController</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="member-name">CommisionController</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method.detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="addCommision(java.util.List,java.lang.Long)">
|
|
<h3>addCommision</h3>
|
|
<div class="member-signature"><span class="annotations">@PostMapping({"/user","/user/{id}"})
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.lang.String></span> <span class="member-name">addCommision</span>​(<span class="parameters">@RequestBody
|
|
java.util.List<java.lang.Long> groups,
|
|
@PathVariable(name="id",required=false)
|
|
java.lang.Long userId)</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>groups</code> - to make assignmetns</dd>
|
|
<dd><code>userId</code> - user to assign to groups</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>was operations success</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAlCommisions(java.lang.Boolean,java.lang.Boolean)">
|
|
<h3>getAlCommisions</h3>
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/user")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.util.List<? extends <a href="../responses/models/CommisionResponse.html" title="class in com.plannaplan.responses.models">CommisionResponse</a>>></span> <span class="member-name">getAlCommisions</span>​(<span class="parameters">@RequestParam(name="groups",defaultValue="false")
|
|
java.lang.Boolean groups,
|
|
@RequestParam(name="extraInfo",defaultValue="false")
|
|
java.lang.Boolean extraInfo)</span>
|
|
throws <span class="exceptions">com.plannaplan.exceptions.UserNotFoundException</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>groups</code> - should include groups list in response</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>list of user all commisions (history of schedules)</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>com.plannaplan.exceptions.UserNotFoundException</code> - if user was found</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAllAssignmets()">
|
|
<h3>getAllAssignmets</h3>
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/user/assignments")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentDetailedResponse.html" title="class in com.plannaplan.responses.models">AssignmentDetailedResponse</a>>></span> <span class="member-name">getAllAssignmets</span>()
|
|
throws <span class="exceptions">com.plannaplan.exceptions.UserNotFoundException</span></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>list of user latests assignmets</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>com.plannaplan.exceptions.UserNotFoundException</code> - if user was not found bny token</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCurrentAssignments()">
|
|
<h3>getCurrentAssignments</h3>
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/user/schedule")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentResponse.html" title="class in com.plannaplan.responses.models">AssignmentResponse</a>>></span> <span class="member-name">getCurrentAssignments</span>()
|
|
throws <span class="exceptions">java.lang.Exception</span></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>current schedule of user indenified via token</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.Exception</code> - if incorrect role was trying to see self schedule (for
|
|
example DEANERY don't have a schedule)</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCommision(java.lang.Long,java.lang.Boolean)">
|
|
<h3>getCommision</h3>
|
|
<div class="member-signature"><span class="annotations">@PreAuthorize("hasRole(\'ROLE_DEANERY\')")
|
|
@GetMapping("/user/{id}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.util.List<? extends <a href="../responses/models/CommisionResponse.html" title="class in com.plannaplan.responses.models">CommisionResponse</a>>></span> <span class="member-name">getCommision</span>​(<span class="parameters">@PathVariable(name="id")
|
|
java.lang.Long userId,
|
|
@RequestParam(name="groups",defaultValue="false")
|
|
java.lang.Boolean groups)</span>
|
|
throws <span class="exceptions">com.plannaplan.exceptions.UserNotFoundException</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>userId</code> - user id in db</dd>
|
|
<dd><code>groups</code> - should commision include assigned groups list</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>list of commisions for given user</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>com.plannaplan.exceptions.UserNotFoundException</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCurrentAssignmentsDeanery(java.lang.Long)">
|
|
<h3>getCurrentAssignmentsDeanery</h3>
|
|
<div class="member-signature"><span class="annotations">@PreAuthorize("hasRole(\'ROLE_DEANERY\')")
|
|
@GetMapping("/user/{id}/schedule")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<java.util.List<<a href="../responses/models/AssignmentResponse.html" title="class in com.plannaplan.responses.models">AssignmentResponse</a>>></span> <span class="member-name">getCurrentAssignmentsDeanery</span>​(<span class="parameters">@PathVariable(name="id")
|
|
java.lang.Long userId)</span>
|
|
throws <span class="exceptions">java.lang.Exception</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>userId</code> - schedule to display owner</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>user's schedule</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.Exception</code> - if incorrect access atempt occured</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFile(javax.servlet.http.HttpServletResponse)">
|
|
<h3>getFile</h3>
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/export/csv")
|
|
@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
|
|
</span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="member-name">getFile</span>​(<span class="parameters">javax.servlet.http.HttpServletResponse response)</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>response</code> - spring response to set headers</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottom-nav" id="navbar.bottom">
|
|
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/CommisionController.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="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<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>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<span class="skip-nav" id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</span></nav>
|
|
<p class="legal-copy"><small>Copyright © 2021. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|