|
- <!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:34 MST 2017 -->
- <title>User (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="User (LibrarySystem - BinHong Lee)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/SettingsTest.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/UserFactory.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/User.html" target="_top">Frames</a></li>
- <li><a href="User.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 User" class="title">Class User</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>libsys.User</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">User</span>
- extends java.lang.Object</pre>
- <div class="block">User 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 java.util.List<java.lang.Integer></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#books">books</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/User.html#id">id</a></span></code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>private int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#limit">limit</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/User.html#name">name</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/User.html#User-java.lang.String-int-int-">User</a></span>(java.lang.String name,
- int id,
- int limit)</code>
- <div class="block">Creates a new User with name, id and limit (usually used to add new User)</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/User.html#User-java.lang.String-int-int-java.util.ArrayList-">User</a></span>(java.lang.String name,
- int id,
- int limit,
- java.util.ArrayList<java.lang.Integer> books)</code>
- <div class="block">Creates a new User with name, id, limit and books (usually used to initialize from database)</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>int[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#bookStatus--">bookStatus</a></span>()</code>
- <div class="block">Get Book ids of the books</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/User.html#borrowNewBook-int-">borrowNewBook</a></span>(int id)</code>
- <div class="block">User borrows a Book</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#getId--">getId</a></span>()</code>
- <div class="block">Gets id of this User</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#getLimit--">getLimit</a></span>()</code>
- <div class="block">Gets limit of Book this User can borrow</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#getName--">getName</a></span>()</code>
- <div class="block">Gets name of this User</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/User.html#returnBook-int-">returnBook</a></span>(int id)</code>
- <div class="block">User returns a Book</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#setLimit-int-">setLimit</a></span>(int limit)</code>
- <div class="block">Change limit of this User</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/User.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code>
- <div class="block">Change name of this User</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/User.html#status--">status</a></span>()</code>
- <div class="block">Check status of the User</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>private java.util.List<java.lang.Integer> books</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="limit">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>limit</h4>
- <pre>private int limit</pre>
- </li>
- </ul>
- <a name="name">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>name</h4>
- <pre>private java.lang.String name</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="User-java.lang.String-int-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>User</h4>
- <pre>public User(java.lang.String name,
- int id,
- int limit)</pre>
- <div class="block">Creates a new User with name, id and limit (usually used to add new User)</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>name</code> - Name of this User</dd>
- <dd><code>id</code> - id of this User</dd>
- <dd><code>limit</code> - Limit of Book this User can borrow</dd>
- </dl>
- </li>
- </ul>
- <a name="User-java.lang.String-int-int-java.util.ArrayList-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>User</h4>
- <pre>public User(java.lang.String name,
- int id,
- int limit,
- java.util.ArrayList<java.lang.Integer> books)</pre>
- <div class="block">Creates a new User with name, id, limit and books (usually used to initialize from database)</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>name</code> - Name of this User</dd>
- <dd><code>id</code> - id of this User</dd>
- <dd><code>limit</code> - Limit of Book this User can borrow</dd>
- <dd><code>books</code> - ArrayList of Book ids borrowed by the User</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="bookStatus--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>bookStatus</h4>
- <pre>public int[] bookStatus()</pre>
- <div class="block">Get Book ids of the books</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Array of Book ids borrowed by this User</dd>
- </dl>
- </li>
- </ul>
- <a name="borrowNewBook-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>borrowNewBook</h4>
- <pre>boolean borrowNewBook(int id)</pre>
- <div class="block">User borrows a Book</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>id</code> - id of the Book to tbe borrowed</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>If the borrowing operation is successful</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">Gets id of this User</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>id</dd>
- </dl>
- </li>
- </ul>
- <a name="getLimit--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLimit</h4>
- <pre>public int getLimit()</pre>
- <div class="block">Gets limit of Book this User can borrow</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Book borrowing limit</dd>
- </dl>
- </li>
- </ul>
- <a name="getName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getName</h4>
- <pre>public java.lang.String getName()</pre>
- <div class="block">Gets name of this User</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Name</dd>
- </dl>
- </li>
- </ul>
- <a name="returnBook-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>returnBook</h4>
- <pre>boolean returnBook(int id)</pre>
- <div class="block">User returns a Book</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>id</code> - id of the Book to be returned</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>If the returning operation is successful</dd>
- </dl>
- </li>
- </ul>
- <a name="setLimit-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setLimit</h4>
- <pre>public void setLimit(int limit)</pre>
- <div class="block">Change limit of this User</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>limit</code> - New limit of the User</dd>
- </dl>
- </li>
- </ul>
- <a name="setName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setName</h4>
- <pre>public void setName(java.lang.String name)</pre>
- <div class="block">Change name of this User</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>name</code> - New name of the User</dd>
- </dl>
- </li>
- </ul>
- <a name="status--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>status</h4>
- <pre>public boolean status()</pre>
- <div class="block">Check status of the User</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>If the User is already at the borrowing limit</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/SettingsTest.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/UserFactory.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/User.html" target="_top">Frames</a></li>
- <li><a href="User.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>
|