blob: b691cd8e3affdcbd22b0bbaecd8dd5a493e8c7ca [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:13 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OpenBookService (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="OpenBookService (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OpenBookService.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-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../openbook/server/DataLoader.html" title="class in openbook.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openbook/server/OpenBookService.html" target="_top">Frames</a></li>
<li><a href="OpenBookService.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>Constr&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>Constr&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">openbook.server</div>
<h2 title="Interface OpenBookService" class="title">Interface OpenBookService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">OpenBookService</span></pre>
<div class="block">A simple service to select Books, purchase them and manage their inventory.
A service handle can be obtained from <a href="../../openbook/server/ServiceFactory.html#getService-java.lang.String-"><code>Service Factory</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pinaki Poddar</dd>
</dl>
</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>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#DEFAULT_UNIT_NAME">DEFAULT_UNIT_NAME</a></span></code>&nbsp;</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#clean--">clean</a></span>()</code>
<div class="block">Cleans everything.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#count-java.lang.Class-">count</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</code>
<div class="block">Count the number of instances of the given persistent type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#deliver-openbook.domain.PurchaseOrder-">deliver</a></span>(<a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&nbsp;order)</code>
<div class="block">Delivers the given order.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getExtent-java.lang.Class-">getExtent</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;entity)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getOrders-openbook.domain.PurchaseOrder.Status-openbook.domain.Customer-">getOrders</a></span>(<a href="../../openbook/domain/PurchaseOrder.Status.html" title="enum in openbook.domain">PurchaseOrder.Status</a>&nbsp;status,
<a href="../../openbook/domain/Customer.html" title="class in openbook.domain">Customer</a>&nbsp;customer)</code>
<div class="block">Gets the list of orders of given status.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getQuery-java.lang.String-java.lang.Double-java.lang.Double-java.lang.String-">getQuery</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;min,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author)</code>
<div class="block">Gets the query String for the given parameters.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/Inventory.html" title="class in openbook.domain">Inventory</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getReorderableBooks-int-">getReorderableBooks</a></span>(int&nbsp;limit)</code>
<div class="block">Gets the list of Books whose inventory is lower than the given limit.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>javax.persistence.EntityManagerFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getUnit--">getUnit</a></span>()</code>
<div class="block">Gets the underlying persistence unit.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#getUnitName--">getUnitName</a></span>()</code>
<div class="block">Gets the name of the underlying persistence unit.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#initialize-java.util.Map-">initialize</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;loadParameters)</code>
<div class="block">Populates the underlying data repository with sample values, only if
the data repository is empty.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#isManaged--">isManaged</a></span>()</code>
<div class="block">Affirms if the transaction on this persistence unit is managed by a container.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../openbook/domain/Customer.html" title="class in openbook.domain">Customer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#login-java.lang.String-">login</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Starts a session for the given named Customer.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#placeOrder-openbook.domain.ShoppingCart-">placeOrder</a></span>(<a href="../../openbook/domain/ShoppingCart.html" title="class in openbook.domain">ShoppingCart</a>&nbsp;cart)</code>
<div class="block">Buys the content of the given cart.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#query-java.lang.String-java.lang.Class-openbook.server.QueryDecorator...-">query</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jpql,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;resultClass,
<a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server">QueryDecorator</a>...&nbsp;decorators)</code>
<div class="block">Runs an arbitrary JPQL query to return a list of result.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#select-java.lang.String-java.lang.Double-java.lang.Double-java.lang.String-openbook.server.QueryDecorator...-">select</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;min,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author,
<a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server">QueryDecorator</a>...&nbsp;decorators)</code>
<div class="block">Selects a list of Books matching the given conditions.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openbook/server/OpenBookService.html#supply-openbook.domain.Book-int-">supply</a></span>(<a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a>&nbsp;b,
int&nbsp;quantity)</code>
<div class="block">Add inventory of the given Book by the given quantity.</div>
</td>
</tr>
</table>
</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="DEFAULT_UNIT_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_UNIT_NAME</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_UNIT_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#openbook.server.OpenBookService.DEFAULT_UNIT_NAME">Constant Field Values</a></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="login-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>login</h4>
<pre><a href="../../openbook/domain/Customer.html" title="class in openbook.domain">Customer</a>&nbsp;login(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Starts a session for the given named Customer.
If no record of the given name exists, a new Customer record is created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of a possibly existing customer. Or a new one.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Customer</dd>
</dl>
</li>
</ul>
<a name="select-java.lang.String-java.lang.Double-java.lang.Double-java.lang.String-openbook.server.QueryDecorator...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a>&gt;&nbsp;select(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;min,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author,
<a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server">QueryDecorator</a>...&nbsp;decorators)</pre>
<div class="block">Selects a list of Books matching the given conditions.
Each of the conditional parameter can be null.
A null parameter implies that the resultant query should ignore that parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>title</code> - title of the Book</dd>
<dd><code>min</code> - minimum price</dd>
<dd><code>max</code> - maximum price</dd>
<dd><code>author</code> - name of author</dd>
<dd><code>decorators</code> - to modify the executable query such as its range.</dd>
</dl>
</li>
</ul>
<a name="getQuery-java.lang.String-java.lang.Double-java.lang.Double-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuery</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQuery(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;min,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author)</pre>
<div class="block">Gets the query String for the given parameters.
Each of the conditional parameter can be null.
A null parameter implies that the resultant query should ignore that parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>title</code> - title of the Book</dd>
<dd><code>min</code> - minimum price</dd>
<dd><code>max</code> - maximum price</dd>
<dd><code>author</code> - name of author</dd>
<dd><code>decorators</code> - to modify the executable query such as its range.</dd>
</dl>
</li>
</ul>
<a name="query-java.lang.String-java.lang.Class-openbook.server.QueryDecorator...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;query(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jpql,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;resultClass,
<a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server">QueryDecorator</a>...&nbsp;decorators)</pre>
<div class="block">Runs an arbitrary JPQL query to return a list of result.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpql</code> - a valid JPQL query string.</dd>
<dd><code>resultClass</code> - type of the result.</dd>
<dd><code>decorators</code> - zero or more QueryDecorators to be applied before Query is executed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the selected instances.</dd>
</dl>
</li>
</ul>
<a name="getExtent-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtent</h4>
<pre>&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;getExtent(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;entity)</pre>
</li>
</ul>
<a name="placeOrder-openbook.domain.ShoppingCart-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>placeOrder</h4>
<pre><a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&nbsp;placeOrder(<a href="../../openbook/domain/ShoppingCart.html" title="class in openbook.domain">ShoppingCart</a>&nbsp;cart)</pre>
<div class="block">Buys the content of the given cart.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cart</code> - a non-empty cart.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a PurchaseOrder for the content of the cart.</dd>
</dl>
</li>
</ul>
<a name="deliver-openbook.domain.PurchaseOrder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliver</h4>
<pre><a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&nbsp;deliver(<a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&nbsp;order)</pre>
<div class="block">Delivers the given order. Delivery changes the status of the order, decrements
inventory and finally removes the line items.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>order</code> - a PENDING order to be delivered.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the PurchaseOrder after delivery.</dd>
</dl>
</li>
</ul>
<a name="supply-openbook.domain.Book-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supply</h4>
<pre><a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a>&nbsp;supply(<a href="../../openbook/domain/Book.html" title="class in openbook.domain">Book</a>&nbsp;b,
int&nbsp;quantity)</pre>
<div class="block">Add inventory of the given Book by the given quantity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - a Book whose inventory is to be incremented</dd>
<dd><code>quantity</code> - positive number.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Book after incrementing its inventory.</dd>
</dl>
</li>
</ul>
<a name="getOrders-openbook.domain.PurchaseOrder.Status-openbook.domain.Customer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrders</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/PurchaseOrder.html" title="class in openbook.domain">PurchaseOrder</a>&gt;&nbsp;getOrders(<a href="../../openbook/domain/PurchaseOrder.Status.html" title="enum in openbook.domain">PurchaseOrder.Status</a>&nbsp;status,
<a href="../../openbook/domain/Customer.html" title="class in openbook.domain">Customer</a>&nbsp;customer)</pre>
<div class="block">Gets the list of orders of given status.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - status of the orders. null implies all orders.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of orders sorted by their placement dates.</dd>
</dl>
</li>
</ul>
<a name="getReorderableBooks-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReorderableBooks</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../openbook/domain/Inventory.html" title="class in openbook.domain">Inventory</a>&gt;&nbsp;getReorderableBooks(int&nbsp;limit)</pre>
<div class="block">Gets the list of Books whose inventory is lower than the given limit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>limit</code> - reorder limit. null implies all inventory.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of Books with inventory lower than the given limit.</dd>
</dl>
</li>
</ul>
<a name="count-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>long&nbsp;count(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</pre>
<div class="block">Count the number of instances of the given persistent type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - a persistent type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of persistent entity of the given type.</dd>
</dl>
</li>
</ul>
<a name="initialize-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>boolean&nbsp;initialize(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;loadParameters)</pre>
<div class="block">Populates the underlying data repository with sample values, only if
the data repository is empty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loadParameters</code> - control the number of Books etc. to be created.
null is allowed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the repository is initialized by this invocation.</dd>
</dl>
</li>
</ul>
<a name="clean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clean</h4>
<pre>void&nbsp;clean()</pre>
<div class="block">Cleans everything. Be careful.</div>
</li>
</ul>
<a name="getUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnit</h4>
<pre>javax.persistence.EntityManagerFactory&nbsp;getUnit()</pre>
<div class="block">Gets the underlying persistence unit.</div>
</li>
</ul>
<a name="getUnitName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnitName</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUnitName()</pre>
<div class="block">Gets the name of the underlying persistence unit.</div>
</li>
</ul>
<a name="isManaged--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isManaged</h4>
<pre>boolean&nbsp;isManaged()</pre>
<div class="block">Affirms if the transaction on this persistence unit is managed by a container.</div>
</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/OpenBookService.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-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../openbook/server/DataLoader.html" title="class in openbook.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openbook/server/QueryDecorator.html" title="interface in openbook.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openbook/server/OpenBookService.html" target="_top">Frames</a></li>
<li><a href="OpenBookService.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>