|
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_131) on Mon Jun 05 21:49:33 MST 2017 -->
- <title>Handler (LibrarySystem - BinHong Lee)</title>
- <meta name="date" content="2017-06-05">
- <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="Handler (LibrarySystem - BinHong Lee)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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="../libsys/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</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">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../libsys/EditUserDialog.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/HandlerTest.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/Handler.html" target="_top">Frames</a></li>
- <li><a href="Handler.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../allclasses-noframe.html">All 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: </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="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </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">libsys</div>
- <h2 title="Class Handler" class="title">Class Handler</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>libsys.Handler</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>class <span class="typeNameLabel">Handler</span>
- extends java.lang.Object</pre>
- <div class="block">Handles all the background operations of MainGUI, also contains both UserFactory and BookFactory</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"> </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>(package private) <a href="../libsys/BookFactory.html" title="class in libsys">BookFactory</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#books">books</a></span></code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>private java.util.Calendar</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#cal">cal</a></span></code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>(package private) <a href="../libsys/UserFactory.html" title="class in libsys">UserFactory</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#users">users</a></span></code> </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"> </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="../libsys/Handler.html#Handler--">Handler</a></span>()</code>
- <div class="block">Creates new empty Handler</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>(package private) java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#bookIdsToTitlesString-int:A-">bookIdsToTitlesString</a></span>(int[] bookIDs)</code>
- <div class="block">Create a String of all book titles with the given Book ids</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>(package private) boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#borrowBook-libsys.User-libsys.Book-">borrowBook</a></span>(<a href="../libsys/User.html" title="class in libsys">User</a> user,
- <a href="../libsys/Book.html" title="class in libsys">Book</a> book)</code>
- <div class="block">Given User borrows the given Book</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>private int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#calDueDate-int-">calDueDate</a></span>(int days)</code>
- <div class="block">Calculating the due date</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>(package private) int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#calDueDate-int-int:A-">calDueDate</a></span>(int days,
- int[] date)</code> </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>private int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#currentDay--">currentDay</a></span>()</code>
- <div class="block">Returns the current date in an int array</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>(package private) boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Handler.html#returnBook-libsys.User-libsys.Book-">returnBook</a></span>(<a href="../libsys/User.html" title="class in libsys">User</a> user,
- <a href="../libsys/Book.html" title="class in libsys">Book</a> book)</code>
- <div class="block">Given User returns the given Book</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 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="books">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>books</h4>
- <pre><a href="../libsys/BookFactory.html" title="class in libsys">BookFactory</a> books</pre>
- </li>
- </ul>
- <a name="cal">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>cal</h4>
- <pre>private java.util.Calendar cal</pre>
- </li>
- </ul>
- <a name="users">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>users</h4>
- <pre><a href="../libsys/UserFactory.html" title="class in libsys">UserFactory</a> users</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="Handler--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Handler</h4>
- <pre>public Handler()</pre>
- <div class="block">Creates new empty Handler</div>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="bookIdsToTitlesString-int:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>bookIdsToTitlesString</h4>
- <pre>java.lang.String bookIdsToTitlesString(int[] bookIDs)</pre>
- <div class="block">Create a String of all book titles with the given Book ids</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>bookIDs</code> - Array of Book ids</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>String of book titles separated with "; "</dd>
- </dl>
- </li>
- </ul>
- <a name="borrowBook-libsys.User-libsys.Book-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>borrowBook</h4>
- <pre>boolean borrowBook(<a href="../libsys/User.html" title="class in libsys">User</a> user,
- <a href="../libsys/Book.html" title="class in libsys">Book</a> book)</pre>
- <div class="block">Given User borrows the given Book</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>user</code> - User borrowing the Book</dd>
- <dd><code>book</code> - Book to be borrowed</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>If the borrow operation is successful</dd>
- </dl>
- </li>
- </ul>
- <a name="calDueDate-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>calDueDate</h4>
- <pre>private int[] calDueDate(int days)</pre>
- <div class="block">Calculating the due date</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>days</code> - Amount of days to be borrowed</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Amount of days added to the current day</dd>
- </dl>
- </li>
- </ul>
- <a name="calDueDate-int-int:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>calDueDate</h4>
- <pre>int[] calDueDate(int days,
- int[] date)</pre>
- </li>
- </ul>
- <a name="currentDay--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>currentDay</h4>
- <pre>private int[] currentDay()</pre>
- <div class="block">Returns the current date in an int array</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>date in ([YYYY][MM][DD]) format</dd>
- </dl>
- </li>
- </ul>
- <a name="returnBook-libsys.User-libsys.Book-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>returnBook</h4>
- <pre>boolean returnBook(<a href="../libsys/User.html" title="class in libsys">User</a> user,
- <a href="../libsys/Book.html" title="class in libsys">Book</a> book)</pre>
- <div class="block">Given User returns the given Book</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>user</code> - User returning the Book</dd>
- <dd><code>book</code> - Book to be returned</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>If the return operation is successful</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="../libsys/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</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">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../libsys/EditUserDialog.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/HandlerTest.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/Handler.html" target="_top">Frames</a></li>
- <li><a href="Handler.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../allclasses-noframe.html">All 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: </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="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|