| <!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_92) on Wed Dec 06 14:36:23 CET 2017 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>ODataJPATombstoneEntityListener (olingo-odata2-parent 2.0.10 API)</title> | |
| <meta name="date" content="2017-12-06"> | |
| <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="ODataJPATombstoneEntityListener (olingo-odata2-parent 2.0.10 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":10,"i1":6,"i2":6,"i3":10}; | |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ODataJPATombstoneEntityListener.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="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneContext.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATransaction.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html" target="_top">Frames</a></li> | |
| <li><a href="ODataJPATombstoneEntityListener.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>Field | </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>Field | </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">org.apache.olingo.odata2.jpa.processor.api</div> | |
| <h2 title="Class ODataJPATombstoneEntityListener" class="title">Class ODataJPATombstoneEntityListener</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.apache.olingo.odata2.jpa.processor.api.ODataJPATombstoneEntityListener</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>Direct Known Subclasses:</dt> | |
| <dd><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAQueryExtensionEntityListener.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPAQueryExtensionEntityListener</a>, <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/ref/listeners/SalesOrderItemTombstoneListener.html" title="class in org.apache.olingo.odata2.jpa.processor.ref.listeners">SalesOrderItemTombstoneListener</a>, <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/ref/listeners/SalesOrderTombstoneListener.html" title="class in org.apache.olingo.odata2.jpa.processor.ref.listeners">SalesOrderTombstoneListener</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public abstract class <span class="typeNameLabel">ODataJPATombstoneEntityListener</span> | |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> | |
| <div class="block">Extend this class and implement a JPA Entity Listener as specified in JSR 317 Java Persistence 2.0. | |
| The class provides abstract methods that shall be implemented by JPA application to handle OData Tombstone features. | |
| The implemented JPA Entity Listener classes will be called back from OData JPA Processor Library.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== 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="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html#ODataJPATombstoneEntityListener--">ODataJPATombstoneEntityListener</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html#addToDelta-java.lang.Object-java.lang.String-">addToDelta</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityName)</code> </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/6/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="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html#generateDeltaToken-java.util.List-javax.persistence.Query-">generateDeltaToken</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> deltas, | |
| javax.persistence.Query query)</code> | |
| <div class="block">Implement this method to create a delta token.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>abstract javax.persistence.Query</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html#getQuery-org.apache.olingo.odata2.api.uri.info.GetEntitySetUriInfo-javax.persistence.EntityManager-">getQuery</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetUriInfo</a> resultsView, | |
| javax.persistence.EntityManager em)</code> | |
| <div class="block">Implement this method to create a <code>Query</code> object.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html#isTombstoneSupported--">isTombstoneSupported</a></span>()</code> | |
| <div class="block">Implement this method to indicate whether the extended class can handle OData Tombstone feature as well</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.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="ODataJPATombstoneEntityListener--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>ODataJPATombstoneEntityListener</h4> | |
| <pre>public ODataJPATombstoneEntityListener()</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="addToDelta-java.lang.Object-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addToDelta</h4> | |
| <pre>protected final void addToDelta(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityName)</pre> | |
| </li> | |
| </ul> | |
| <a name="getQuery-org.apache.olingo.odata2.api.uri.info.GetEntitySetUriInfo-javax.persistence.EntityManager-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getQuery</h4> | |
| <pre>public abstract javax.persistence.Query getQuery(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetUriInfo</a> resultsView, | |
| javax.persistence.EntityManager em) | |
| throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre> | |
| <div class="block">Implement this method to create a <code>Query</code> object. The Query object can be created from | |
| OData requests. The query instance thus created can be used for handling delta JPA entities. The delta token passed | |
| from OData request can | |
| be accessed from <code>com.sap.core.odata.processor.api.jpa.ODataJPATombstoneContext</code>.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>resultsView</code> - is a reference to OData request</dd> | |
| <dd><code>em</code> - is a reference to <code>EntityManager</code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>an instance of type <code>Query</code></dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="generateDeltaToken-java.util.List-javax.persistence.Query-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>generateDeltaToken</h4> | |
| <pre>public abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> generateDeltaToken(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> deltas, | |
| javax.persistence.Query query)</pre> | |
| <div class="block">Implement this method to create a delta token.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>deltas</code> - is list of delta JPA Entities</dd> | |
| <dd><code>query</code> - is an instance of type <code>Query</code> that was used for handling delta entites</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a delta token of type String</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isTombstoneSupported--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>isTombstoneSupported</h4> | |
| <pre>public boolean isTombstoneSupported()</pre> | |
| <div class="block">Implement this method to indicate whether the extended class can handle OData Tombstone feature as well</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true by default</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/ODataJPATombstoneEntityListener.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="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneContext.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATransaction.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html" target="_top">Frames</a></li> | |
| <li><a href="ODataJPATombstoneEntityListener.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>Field | </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>Field | </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 ======= --> | |
| <p class="legalCopy"><small>Copyright © 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> | |
| </body> | |
| </html> |