[teiid-commits] teiid SVN: r3728 - in trunk: documentation/developer-guide/src/main/docbook/en-US/content and 1 other directory.

[teiid-commits at lists.jboss.org]

Author: shawkins
Date: 2011-12-08 14:19:34 -0500 (Thu, 08 Dec 2011)
New Revision: 3728

Modified:
   trunk/api/src/main/java/org/teiid/CommandListener.java
   trunk/documentation/developer-guide/src/main/docbook/en-US/content/translator-api.xml
Log:
TEIID-1604 cleaning up methods/javadoc and adding a commandlistener for close events.

Modified: trunk/api/src/main/java/org/teiid/CommandListener.java
===================================================================
--- trunk/api/src/main/java/org/teiid/CommandListener.java	2011-12-08 18:54:42 UTC (rev 3727)
+++ trunk/api/src/main/java/org/teiid/CommandListener.java	2011-12-08 19:19:34 UTC (rev 3728)
@@ -22,6 +22,9 @@
 
 package org.teiid;
 
+/**
+ * Listener for command events.
+ */
 public interface CommandListener {
 	
 	void commandClosed(CommandContext context);

Modified: trunk/documentation/developer-guide/src/main/docbook/en-US/content/translator-api.xml
===================================================================
--- trunk/documentation/developer-guide/src/main/docbook/en-US/content/translator-api.xml	2011-12-08 18:54:42 UTC (rev 3727)
+++ trunk/documentation/developer-guide/src/main/docbook/en-US/content/translator-api.xml	2011-12-08 19:19:34 UTC (rev 3728)
@@ -268,7 +268,7 @@
 			<title>ExecutionContext</title>
 			<para>The <code>org.teiid.translator.ExecutionContext</code> provides a considerable amount of information related to the current execution.  
 			An <code>ExecutionContext</code> instance is made available to each <code>Execution</code>.  Specific usage is highlighted in this guide where applicable, but you may use any informational getter method as desired.
-			Example usage would include calling <code>ExecutionContext.getRequestIdentifier()</code>, <code>ExecutionContext.getSession()</code>, etc. for logging purposes.</para>
+			Example usage would include calling <code>ExecutionContext.getRequestId()</code>, <code>ExecutionContext.getSession()</code>, etc. for logging purposes.</para>
 			
 			<section>
 				<title>Source Hints</title>