|
- <!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:32 MST 2017 -->
- <title>Book (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="Book (LibrarySystem - BinHong Lee)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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>Prev Class</li>
- <li><a href="../libsys/BookFactory.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/Book.html" target="_top">Frames</a></li>
- <li><a href="Book.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 Book" class="title">Class Book</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>libsys.Book</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">Book</span>
- extends java.lang.Object</pre>
- <div class="block">Book object</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>private int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#dueDate">dueDate</a></span></code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>private int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#id">id</a></span></code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>private java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#status">status</a></span></code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>private java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#title">title</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/Book.html#Book-int-">Book</a></span>(int id)</code>
- <div class="block">Create new Book with given id (Usually used as placeholders)</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/Book.html#Book-int-java.lang.String-java.lang.String-int:A-">Book</a></span>(int id,
- java.lang.String title,
- java.lang.String status,
- int[] dueDate)</code>
- <div class="block">Create new Book with given id, title, status and dueDate (Usually used for initialization from database)</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/Book.html#Book-java.lang.String-int-java.lang.String-">Book</a></span>(java.lang.String title,
- int id,
- java.lang.String status)</code>
- <div class="block">Create new Book with given title, id and status (Usually used for new Book creation)</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) int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#getDueDate--">getDueDate</a></span>()</code>
- <div class="block">Returns the due date of the Book</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#getId--">getId</a></span>()</code>
- <div class="block">Returns the id of the Book</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#getStatus--">getStatus</a></span>()</code>
- <div class="block">Returns the status of the Book</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#getTitle--">getTitle</a></span>()</code>
- <div class="block">Returns the title of the Book</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#overdueFine-int:A-">overdueFine</a></span>(int[] currentDay)</code>
- <div class="block">Calculate the overdue fine</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/Book.html#rent-int:A-">rent</a></span>(int[] dueDate)</code>
- <div class="block">Call to rent book, return if renting is successful</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>(package private) void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#returned--">returned</a></span>()</code>
- <div class="block">Return the Book to the shelf</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Book.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String title)</code>
- <div class="block">Set the title to the given title</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="dueDate">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dueDate</h4>
- <pre>private int[] dueDate</pre>
- </li>
- </ul>
- <a name="id">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>id</h4>
- <pre>private int id</pre>
- </li>
- </ul>
- <a name="status">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>status</h4>
- <pre>private java.lang.String status</pre>
- </li>
- </ul>
- <a name="title">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>title</h4>
- <pre>private java.lang.String title</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="Book-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Book</h4>
- <pre>public Book(int id)</pre>
- <div class="block">Create new Book with given id (Usually used as placeholders)</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>id</code> - Identification number of the Book</dd>
- </dl>
- </li>
- </ul>
- <a name="Book-int-java.lang.String-java.lang.String-int:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Book</h4>
- <pre>public Book(int id,
- java.lang.String title,
- java.lang.String status,
- int[] dueDate)</pre>
- <div class="block">Create new Book with given id, title, status and dueDate (Usually used for initialization from database)</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>id</code> - Identification number of the Book</dd>
- <dd><code>title</code> - Title of the Book</dd>
- <dd><code>status</code> - Status of the Book</dd>
- <dd><code>dueDate</code> - Due date of the Book</dd>
- </dl>
- </li>
- </ul>
- <a name="Book-java.lang.String-int-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Book</h4>
- <pre>public Book(java.lang.String title,
- int id,
- java.lang.String status)</pre>
- <div class="block">Create new Book with given title, id and status (Usually used for new Book creation)</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>title</code> - Title of the Book</dd>
- <dd><code>id</code> - Identification number of the Book</dd>
- <dd><code>status</code> - Status of the Book</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="getDueDate--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDueDate</h4>
- <pre>int[] getDueDate()</pre>
- <div class="block">Returns the due date of the Book</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>due date ([yyyy][mm][dd])</dd>
- </dl>
- </li>
- </ul>
- <a name="getId--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getId</h4>
- <pre>public int getId()</pre>
- <div class="block">Returns the id of the Book</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>id</dd>
- </dl>
- </li>
- </ul>
- <a name="getStatus--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getStatus</h4>
- <pre>public java.lang.String getStatus()</pre>
- <div class="block">Returns the status of the Book</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>status (AVAILABLE || RENTED || RESERVED || NOT AVAILABLE)</dd>
- </dl>
- </li>
- </ul>
- <a name="getTitle--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getTitle</h4>
- <pre>public java.lang.String getTitle()</pre>
- <div class="block">Returns the title of the Book</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>title</dd>
- </dl>
- </li>
- </ul>
- <a name="overdueFine-int:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>overdueFine</h4>
- <pre>public double overdueFine(int[] currentDay)</pre>
- <div class="block">Calculate the overdue fine</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>currentDay</code> - Today's date</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Price of the fine</dd>
- </dl>
- </li>
- </ul>
- <a name="rent-int:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>rent</h4>
- <pre>boolean rent(int[] dueDate)</pre>
- <div class="block">Call to rent book, return if renting is successful</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>dueDate</code> - The new due date of the Book</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>if renting is successful</dd>
- </dl>
- </li>
- </ul>
- <a name="returned--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>returned</h4>
- <pre>void returned()</pre>
- <div class="block">Return the Book to the shelf</div>
- </li>
- </ul>
- <a name="setTitle-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>setTitle</h4>
- <pre>public void setTitle(java.lang.String title)</pre>
- <div class="block">Set the title to the given title</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>title</code> - The new title of the Book</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>Prev Class</li>
- <li><a href="../libsys/BookFactory.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/Book.html" target="_top">Frames</a></li>
- <li><a href="Book.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>
|