Files
kBorrow/doc/de/katho/kBorrow/controller/ArticleController.html
2015-01-27 17:11:10 +01:00

437 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Tue Jan 27 17:10:43 CET 2015 -->
<title>ArticleController</title>
<meta name="date" content="2015-01-27">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ArticleController";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ArticleController.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../de/katho/kBorrow/controller/ManageLendingsController.html" title="class in de.katho.kBorrow.controller"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/katho/kBorrow/controller/ArticleController.html" target="_top">Frames</a></li>
<li><a href="ArticleController.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">de.katho.kBorrow.controller</div>
<h2 title="Class ArticleController" class="title">Class ArticleController</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>de.katho.kBorrow.controller.ArticleController</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ArticleController</span>
extends java.lang.Object</pre>
<div class="block">ArticleController f<>hrt s<>mtliche Datenbankoperationen durch, die durch <a href="../../../../de/katho/kBorrow/gui/ArticlePanel.html" title="class in de.katho.kBorrow.gui"><code>ArticlePanel</code></a> angesto<74>en werden.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../de/katho/kBorrow/interfaces/DbConnector.html" title="interface in de.katho.kBorrow.interfaces">DbConnector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#dbCon">dbCon</a></span></code>
<div class="block">Referenz auf die Datenbank</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../de/katho/kBorrow/data/KArticleModel.html" title="class in de.katho.kBorrow.data">KArticleModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#kArticleModel">kArticleModel</a></span></code>
<div class="block">Referenz auf das KArticleModel.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#ArticleController-de.katho.kBorrow.interfaces.DbConnector-java.util.HashMap-">ArticleController</a></span>(<a href="../../../../de/katho/kBorrow/interfaces/DbConnector.html" title="interface in de.katho.kBorrow.interfaces">DbConnector</a>&nbsp;pDbCon,
java.util.HashMap&lt;java.lang.String,<a href="../../../../de/katho/kBorrow/interfaces/KDataModel.html" title="interface in de.katho.kBorrow.interfaces">KDataModel</a>&gt;&nbsp;models)</code>
<div class="block">Erzeugt eine neue Instanz des ArticleController.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#createArticle-java.lang.String-java.lang.String-">createArticle</a></span>(java.lang.String&nbsp;pName,
java.lang.String&nbsp;pDesc)</code>
<div class="block">Erzeugt einen neuen Artikel in der Datenbank und aktualisiert die Tabelle
Gibt je nach Bearbeitungsergebnis einen anderen Statuscode aus:
0: Artikel erfolgreich erzeugt.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#deleteArticle-int-">deleteArticle</a></span>(int&nbsp;pId)</code>
<div class="block">L<EFBFBD>scht den Artikel mit der gegebenen ID in der Datenbank und aktualisiert die Tabelle.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/katho/kBorrow/controller/ArticleController.html#editArticle-int-java.lang.String-java.lang.String-">editArticle</a></span>(int&nbsp;pId,
java.lang.String&nbsp;pName,
java.lang.String&nbsp;pDesc)</code>
<div class="block"><EFBFBD>ndert einen Artikel in der Datenbank und aktualisiert die Tabelle
Gibt je nach Bearbeitungsergebnis einen anderen Statuscode aus:
0: Artikel erfolgreich ge<67>ndert
1: SQL-Fehler beim Erzeugen
2: Artikelname ist leer
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="dbCon">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dbCon</h4>
<pre>private&nbsp;<a href="../../../../de/katho/kBorrow/interfaces/DbConnector.html" title="interface in de.katho.kBorrow.interfaces">DbConnector</a> dbCon</pre>
<div class="block">Referenz auf die Datenbank</div>
</li>
</ul>
<a name="kArticleModel">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>kArticleModel</h4>
<pre>private&nbsp;<a href="../../../../de/katho/kBorrow/data/KArticleModel.html" title="class in de.katho.kBorrow.data">KArticleModel</a> kArticleModel</pre>
<div class="block">Referenz auf das KArticleModel. Wird ben<65>tigt, um Tabellen und Listen zu aktualisieren.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ArticleController-de.katho.kBorrow.interfaces.DbConnector-java.util.HashMap-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ArticleController</h4>
<pre>public&nbsp;ArticleController(<a href="../../../../de/katho/kBorrow/interfaces/DbConnector.html" title="interface in de.katho.kBorrow.interfaces">DbConnector</a>&nbsp;pDbCon,
java.util.HashMap&lt;java.lang.String,<a href="../../../../de/katho/kBorrow/interfaces/KDataModel.html" title="interface in de.katho.kBorrow.interfaces">KDataModel</a>&gt;&nbsp;models)</pre>
<div class="block">Erzeugt eine neue Instanz des ArticleController.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pDbCon</code> - Referenz auf die Datenbank</dd>
<dd><code>models</code> - HashMap, die die KDataModels enth<74>lt.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createArticle-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createArticle</h4>
<pre>public&nbsp;int&nbsp;createArticle(java.lang.String&nbsp;pName,
java.lang.String&nbsp;pDesc)</pre>
<div class="block">Erzeugt einen neuen Artikel in der Datenbank und aktualisiert die Tabelle
<p>Gibt je nach Bearbeitungsergebnis einen anderen Statuscode aus:</p>
<ul>
<li>0: Artikel erfolgreich erzeugt.</li>
<li>1: SQL-Fehler beim Erzeugen.</li>
<li>2: Feld "Name" ist leer</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pName</code> - Name des Artikels</dd>
<dd><code>pDesc</code> - Beschreibung des Artikels</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Statuscode als Int.</dd>
</dl>
</li>
</ul>
<a name="editArticle-int-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>editArticle</h4>
<pre>public&nbsp;int&nbsp;editArticle(int&nbsp;pId,
java.lang.String&nbsp;pName,
java.lang.String&nbsp;pDesc)</pre>
<div class="block"><EFBFBD>ndert einen Artikel in der Datenbank und aktualisiert die Tabelle
<p>Gibt je nach Bearbeitungsergebnis einen anderen Statuscode aus:</p>
<ul>
<li>0: Artikel erfolgreich ge<67>ndert</li>
<li>1: SQL-Fehler beim Erzeugen</li>
<li>2: Artikelname ist leer</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pId</code> - Id des Artikels, der ge<67>ndert werden soll</dd>
<dd><code>pName</code> - (Neuer) Name des Artikels</dd>
<dd><code>pDesc</code> - (Neue) Beschreibung des Artikels</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Statuscode als Int.</dd>
</dl>
</li>
</ul>
<a name="deleteArticle-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deleteArticle</h4>
<pre>public&nbsp;int&nbsp;deleteArticle(int&nbsp;pId)</pre>
<div class="block">L<EFBFBD>scht den Artikel mit der gegebenen ID in der Datenbank und aktualisiert die Tabelle.
<p>Gibt je nach Bearbeitungsergebnis einen anderen Statuscode aus:</p>
<ul>
<li>0: Artikel konnte erfolgreich gel<65>scht werden.</li>
<li>1: Artikel konnte nicht gel<65>scht werden, unbekannter Fehler (SQL-Fehler).</li>
<li>2: Artikel konnte nicht gel<65>scht werden, weil er im Moment verliehen ist.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pId</code> - ID des Artikels, der gel<65>scht werden soll.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Statuscode als Int.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ArticleController.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../de/katho/kBorrow/controller/ManageLendingsController.html" title="class in de.katho.kBorrow.controller"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/katho/kBorrow/controller/ArticleController.html" target="_top">Frames</a></li>
<li><a href="ArticleController.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>