224 lines
14 KiB
HTML
224 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="pt">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Fri Jan 12 16:47:28 BRT 2024 -->
|
|
<title>DoctorService</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2024-01-12">
|
|
<meta name="description" content="declaration: package: com.mirna.hospitalmanagementapi.domain.services, interface: DoctorService">
|
|
<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.6.0.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 evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-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/DoctorService.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" 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.mirna.hospitalmanagementapi.domain.services</a></div>
|
|
<h1 title="Interface DoctorService" class="title">Interface DoctorService</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="../../application/services/DoctorServiceImpl.html" title="class in com.mirna.hospitalmanagementapi.application.services">DoctorServiceImpl</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DoctorService</span></div>
|
|
<div class="block">Doctor service interface for managing doctor information.</div>
|
|
<dl class="notes">
|
|
<dt>Version:</dt>
|
|
<dd>1.0</dd>
|
|
<dt>Author:</dt>
|
|
<dd>Mirna Gama</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities"><code>Doctor</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addDoctor(com.mirna.hospitalmanagementapi.domain.dtos.doctor.DoctorDTO)" class="member-name-link">addDoctor</a><wbr>(<a href="../dtos/doctor/DoctorDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorDTO</a> doctorDTO)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Adds a new doctor to the repository.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deactivateDoctor(java.lang.Long)" class="member-name-link">deactivateDoctor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Deactivates an existing doctor record by provided id</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#findDoctorById(java.lang.Long)" class="member-name-link">findDoctorById</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Finds a stored doctor by id.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.springframework.data.domain.Page<<a href="../dtos/doctor/DoctorPublicDataDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorPublicDataDTO</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#findDoctors(org.springframework.data.domain.Pageable)" class="member-name-link">findDoctors</a><wbr>(org.springframework.data.domain.Pageable pageable)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Retrieves a paginated sublist of doctors.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updateDoctor(com.mirna.hospitalmanagementapi.domain.dtos.doctor.DoctorUpdatedDataDTO)" class="member-name-link">updateDoctor</a><wbr>(<a href="../dtos/doctor/DoctorUpdatedDataDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorUpdatedDataDTO</a> doctorUpdatedDataDTO)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Updates an existing doctor record</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="addDoctor(com.mirna.hospitalmanagementapi.domain.dtos.doctor.DoctorDTO)">
|
|
<h3>addDoctor</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></span> <span class="element-name">addDoctor</span><wbr><span class="parameters">(<a href="../dtos/doctor/DoctorDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorDTO</a> doctorDTO)</span></div>
|
|
<div class="block">Adds a new doctor to the repository.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>doctorDTO</code> - A data transfer object representing a doctor to add.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The saved doctor if successful, or null if there is an error.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="findDoctorById(java.lang.Long)">
|
|
<h3>findDoctorById</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></span> <span class="element-name">findDoctorById</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</span></div>
|
|
<div class="block">Finds a stored doctor by id.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>id</code> - A long representing the doctor's unique identifier</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The corresponding doctor if successful, or null if it is non-existent.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="findDoctors(org.springframework.data.domain.Pageable)">
|
|
<h3>findDoctors</h3>
|
|
<div class="member-signature"><span class="return-type">org.springframework.data.domain.Page<<a href="../dtos/doctor/DoctorPublicDataDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorPublicDataDTO</a>></span> <span class="element-name">findDoctors</span><wbr><span class="parameters">(org.springframework.data.domain.Pageable pageable)</span></div>
|
|
<div class="block">Retrieves a paginated sublist of doctors.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>pageable</code> - Pagination information, such as size and page number</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A paginated sublist containing data transfer objects with doctors public information in the repository</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="updateDoctor(com.mirna.hospitalmanagementapi.domain.dtos.doctor.DoctorUpdatedDataDTO)">
|
|
<h3>updateDoctor</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></span> <span class="element-name">updateDoctor</span><wbr><span class="parameters">(<a href="../dtos/doctor/DoctorUpdatedDataDTO.html" title="class in com.mirna.hospitalmanagementapi.domain.dtos.doctor">DoctorUpdatedDataDTO</a> doctorUpdatedDataDTO)</span></div>
|
|
<div class="block">Updates an existing doctor record</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>doctorUpdatedDataDTO</code> - Data transfer object containing the doctor updated data along with their corresponding id</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The updated doctor if successful, or null if there is an error.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="deactivateDoctor(java.lang.Long)">
|
|
<h3>deactivateDoctor</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="../entities/Doctor.html" title="class in com.mirna.hospitalmanagementapi.domain.entities">Doctor</a></span> <span class="element-name">deactivateDoctor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</span></div>
|
|
<div class="block">Deactivates an existing doctor record by provided id</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>id</code> - Long that represents the doctor's unique identifier</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The deactivated doctor if successful, or null if there is an error.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|