blob: bad3c68ff789cb19a13120cf8ea2e79eb9ce7bc7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Timer</title>
<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="Timer";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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="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="../../jakarta/ejb/Timeout.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/TimerConfig.html" title="class in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/Timer.html" target="_top">Frames</a></li>
<li><a href="Timer.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>Field&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>Field&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">jakarta.ejb</div>
<h2 title="Interface Timer" class="title">Interface Timer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Timer</span></pre>
<div class="block">The <code>Timer</code> interface contains information about a timer
that was created through the enterprise bean Timer Service.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 2.1</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="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="../../jakarta/ejb/Timer.html#cancel--">cancel</a></span>()</code>
<div class="block">Cause the timer and all its associated expiration notifications to
be cancelled.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/TimerHandle.html" title="interface in jakarta.ejb">TimerHandle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#getHandle--">getHandle</a></span>()</code>
<div class="block">Get a serializable handle to the timer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.io.Serializable</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#getInfo--">getInfo</a></span>()</code>
<div class="block">Get the information associated with the timer at the time of
creation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#getNextTimeout--">getNextTimeout</a></span>()</code>
<div class="block">Get the point in time at which the next timer expiration is scheduled
to occur.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#getSchedule--">getSchedule</a></span>()</code>
<div class="block">Get the schedule expression corresponding to this timer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#getTimeRemaining--">getTimeRemaining</a></span>()</code>
<div class="block">Get the number of milliseconds that will elapse before the next
scheduled timer expiration.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#isCalendarTimer--">isCalendarTimer</a></span>()</code>
<div class="block">Return whether this timer is a calendar-based timer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Timer.html#isPersistent--">isPersistent</a></span>()</code>
<div class="block">Return whether this timer has persistent semantics.</div>
</td>
</tr>
</table>
</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="cancel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>void&nbsp;cancel()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Cause the timer and all its associated expiration notifications to
be cancelled.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
</dl>
</li>
</ul>
<a name="getTimeRemaining--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeRemaining</h4>
<pre>long&nbsp;getTimeRemaining()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/NoMoreTimeoutsException.html" title="class in jakarta.ejb">NoMoreTimeoutsException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Get the number of milliseconds that will elapse before the next
scheduled timer expiration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of milliseconds that will elapse before the next
scheduled timer expiration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/NoMoreTimeoutsException.html" title="class in jakarta.ejb">NoMoreTimeoutsException</a></code> - Indicates that the
timer has no future timeouts</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
</dl>
</li>
</ul>
<a name="getNextTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextTimeout</h4>
<pre>java.util.Date&nbsp;getNextTimeout()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/NoMoreTimeoutsException.html" title="class in jakarta.ejb">NoMoreTimeoutsException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Get the point in time at which the next timer expiration is scheduled
to occur.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the point in time at which the next timer expiration is
scheduled to occur.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/NoMoreTimeoutsException.html" title="class in jakarta.ejb">NoMoreTimeoutsException</a></code> - Indicates that the
timer has no future timeouts</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
</dl>
</li>
</ul>
<a name="getSchedule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchedule</h4>
<pre><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;getSchedule()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Get the schedule expression corresponding to this timer. The timer
must be a calendar-based timer. It may have been created automatically
or programmatically.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>schedule expression for the timer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method. Also thrown if invoked on a timer that is not a
calendar-based timer.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 3.1</dd>
</dl>
</li>
</ul>
<a name="isPersistent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPersistent</h4>
<pre>boolean&nbsp;isPersistent()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Return whether this timer has persistent semantics.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean indicating whether the timer is persistent.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 3.1</dd>
</dl>
</li>
</ul>
<a name="isCalendarTimer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCalendarTimer</h4>
<pre>boolean&nbsp;isCalendarTimer()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Return whether this timer is a calendar-based timer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean indicating whether the timer is calendar-based.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 3.1</dd>
</dl>
</li>
</ul>
<a name="getInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfo</h4>
<pre>java.io.Serializable&nbsp;getInfo()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Get the information associated with the timer at the time of
creation. This may be the <code>info</code> string that was
passed to the timer creation method or the <code>info</code>
element of the <code>Schedule</code> annotaiton.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Serializable object that was passed in at timer creation, or
null if the info argument passed in at timer creation was null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</dd>
</dl>
</li>
</ul>
<a name="getHandle--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHandle</h4>
<pre><a href="../../jakarta/ejb/TimerHandle.html" title="interface in jakarta.ejb">TimerHandle</a>&nbsp;getHandle()
throws java.lang.IllegalStateException,
<a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a>,
<a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></pre>
<div class="block">Get a serializable handle to the timer. This handle can
be used at a later time to re-obtain the timer reference.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a serializable handle to the timer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this method is
invoked while the instance is in a state that does not allow access
to this method. Also thrown if invoked on a non-persistent timer.</dd>
<dd><code><a href="../../jakarta/ejb/NoSuchObjectLocalException.html" title="class in jakarta.ejb">NoSuchObjectLocalException</a></code> - If invoked on a timer
that has expired or has been cancelled.</dd>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - If this method could not complete due
to a system-level failure.</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="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="../../jakarta/ejb/Timeout.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/TimerConfig.html" title="class in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/Timer.html" target="_top">Frames</a></li>
<li><a href="Timer.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>Field&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>Field&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 ======= -->
</body>
</html>