| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WorkEvent</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="WorkEvent"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":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="../../../../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="../../../../javax/resource/spi/work/WorkContextProvider.html" title="interface in javax.resource.spi.work"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/resource/spi/work/WorkEvent.html" target="_top">Frames</a></li> |
| <li><a href="WorkEvent.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">javax.resource.spi.work</div> |
| <h2 title="Class WorkEvent" class="title">Class WorkEvent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.util.EventObject</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.resource.spi.work.WorkEvent</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WorkEvent</span> |
| extends java.util.EventObject</pre> |
| <div class="block">This class models the various events that occur during the processing of |
| a <code>Work</code> instance.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#javax.resource.spi.work.WorkEvent">Serialized Form</a></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"> </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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#WORK_ACCEPTED">WORK_ACCEPTED</a></span></code> |
| <div class="block">Indicates <code>Work</code> instance has been accepted.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#WORK_COMPLETED">WORK_COMPLETED</a></span></code> |
| <div class="block">Indicates <code>Work</code> instance has completed execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#WORK_REJECTED">WORK_REJECTED</a></span></code> |
| <div class="block">Indicates <code>Work</code> instance has been rejected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#WORK_STARTED">WORK_STARTED</a></span></code> |
| <div class="block">Indicates <code>Work</code> instance has started execution.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class java.util.EventObject</h3> |
| <code>source</code></li> |
| </ul> |
| </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="../../../../javax/resource/spi/work/WorkEvent.html#WorkEvent-java.lang.Object-int-javax.resource.spi.work.Work-javax.resource.spi.work.WorkException-">WorkEvent</a></span>(java.lang.Object source, |
| int type, |
| <a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a> work, |
| <a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a> exc)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#WorkEvent-java.lang.Object-int-javax.resource.spi.work.Work-javax.resource.spi.work.WorkException-long-">WorkEvent</a></span>(java.lang.Object source, |
| int type, |
| <a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a> work, |
| <a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a> exc, |
| long startDuration)</code> |
| <div class="block">Constructor.</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><a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#getException--">getException</a></span>()</code> |
| <div class="block">Return the <code>WorkException</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#getStartDuration--">getStartDuration</a></span>()</code> |
| <div class="block">Return the start interval duration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#getType--">getType</a></span>()</code> |
| <div class="block">Return the type of this event.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/work/WorkEvent.html#getWork--">getWork</a></span>()</code> |
| <div class="block">Return the <code>Work</code> instance which is the cause of the event.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.util.EventObject</h3> |
| <code>getSource, toString</code></li> |
| </ul> |
| <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, 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="WORK_ACCEPTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WORK_ACCEPTED</h4> |
| <pre>public static final int WORK_ACCEPTED</pre> |
| <div class="block">Indicates <code>Work</code> instance has been accepted.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.resource.spi.work.WorkEvent.WORK_ACCEPTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="WORK_REJECTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WORK_REJECTED</h4> |
| <pre>public static final int WORK_REJECTED</pre> |
| <div class="block">Indicates <code>Work</code> instance has been rejected.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.resource.spi.work.WorkEvent.WORK_REJECTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="WORK_STARTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WORK_STARTED</h4> |
| <pre>public static final int WORK_STARTED</pre> |
| <div class="block">Indicates <code>Work</code> instance has started execution.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.resource.spi.work.WorkEvent.WORK_STARTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="WORK_COMPLETED"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WORK_COMPLETED</h4> |
| <pre>public static final int WORK_COMPLETED</pre> |
| <div class="block">Indicates <code>Work</code> instance has completed execution.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.resource.spi.work.WorkEvent.WORK_COMPLETED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WorkEvent-java.lang.Object-int-javax.resource.spi.work.Work-javax.resource.spi.work.WorkException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WorkEvent</h4> |
| <pre>public WorkEvent(java.lang.Object source, |
| int type, |
| <a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a> work, |
| <a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a> exc)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - The object on which the event initially |
| occurred.</dd> |
| <dd><code>type</code> - The event type.</dd> |
| <dd><code>work</code> - The <code>Work</code> object on which |
| the event occured.</dd> |
| <dd><code>exc</code> - The exception that occured during |
| <code>Work</code> processing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="WorkEvent-java.lang.Object-int-javax.resource.spi.work.Work-javax.resource.spi.work.WorkException-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WorkEvent</h4> |
| <pre>public WorkEvent(java.lang.Object source, |
| int type, |
| <a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a> work, |
| <a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a> exc, |
| long startDuration)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - The object on which the event initially |
| occurred.</dd> |
| <dd><code>type</code> - The event type.</dd> |
| <dd><code>work</code> - The <code>Work</code> object on which |
| the event occured.</dd> |
| <dd><code>exc</code> - The exception that occured during |
| <code>Work</code> processing.</dd> |
| <dd><code>startDuration</code> - The start delay duration |
| (in milliseconds).</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="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public int getType()</pre> |
| <div class="block">Return the type of this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the event type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWork--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWork</h4> |
| <pre>public <a href="../../../../javax/resource/spi/work/Work.html" title="interface in javax.resource.spi.work">Work</a> getWork()</pre> |
| <div class="block">Return the <code>Work</code> instance which is the cause of the event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Work</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartDuration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartDuration</h4> |
| <pre>public long getStartDuration()</pre> |
| <div class="block">Return the start interval duration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time elapsed (in milliseconds) since the <code>Work</code> |
| was accepted, until the <code>Work</code> execution started. Note, |
| this does not offer real-time guarantees. It is valid to return -1, if |
| the actual start interval duration is unknown.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getException--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getException</h4> |
| <pre>public <a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work">WorkException</a> getException()</pre> |
| <div class="block">Return the <code>WorkException</code>. The actual |
| <code>WorkException</code> subtype returned depends on the type of the |
| event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>WorkRejectedException</code> or a |
| <code>WorkCompletedException</code>, if any.</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="../../../../javax/resource/spi/work/WorkContextProvider.html" title="interface in javax.resource.spi.work"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/resource/spi/work/WorkException.html" title="class in javax.resource.spi.work"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/resource/spi/work/WorkEvent.html" target="_top">Frames</a></li> |
| <li><a href="WorkEvent.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> |
