diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/gen/TriggerSupport.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/gen/TriggerSupport.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/gen/TriggerSupport.html | 326 |
1 files changed, 326 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/gen/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html new file mode 100644 index 0000000..6664e02 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html @@ -0,0 +1,326 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TriggerSupport (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TriggerSupport (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/TriggerSupport.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-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="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.gen</div> +<h2 title="Interface TriggerSupport" class="title">Interface TriggerSupport<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S>, <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TriggerSupport<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S></pre> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all update operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyDisableLoadTrigger()">locallyDisableLoadTrigger</a></strong>()</code> +<div class="block">Disables execution of load trigger for the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyEnableLoadTrigger()">locallyEnableLoadTrigger</a></strong>()</code> +<div class="block">Enables execution of load trigger for the current thread, if they it + been disabled before.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.gen.StorableSupport"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></h3> +<code><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository</a>, <a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#isPropertySupported(java.lang.String)">isPropertySupported</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInsertTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInsertTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getInsertTrigger()</pre> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getUpdateTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUpdateTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getUpdateTrigger()</pre> +<div class="block">Returns a trigger which must be run for all update operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getDeleteTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeleteTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getDeleteTrigger()</pre> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoadTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getLoadTrigger()</pre> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableLoadTrigger</h4> +<pre>void locallyDisableLoadTrigger()</pre> +<div class="block">Disables execution of load trigger for the current thread. Call + locallyEnableLoadTrigger to enable again. This call can be made multiple + times, but be sure to call locallyEnableLoadTrigger the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableLoadTrigger()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>locallyEnableLoadTrigger</h4> +<pre>void locallyEnableLoadTrigger()</pre> +<div class="block">Enables execution of load trigger for the current thread, if they it + been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/TriggerSupport.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-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="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |