svn commit: r574256 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java

[sk...@apache.org]

Author: skitching
Date: Mon Sep 10 07:20:45 2007
New Revision: 574256

URL: http://svn.apache.org/viewvc?rev=574256&view=rev
Log:
Update javadoc only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java?rev=574256&r1=574255&r2=574256&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContext.java Mon Sep 10 07:20:45 2007
@@ -21,22 +21,28 @@
 
 /**
  * Interface which will be used by the {@link PersistenceContextConversationInterceptor}
- * to configure the spring persistence framework
+ * to configure the spring persistence framework.
+ * <p>
+ * Implementations of this interface are expected to hold a reference to a real
+ * ORM-specific object (eg a JPA EntityManager or a Hibernate Session).
  */
 public interface PersistenceContext
 {
 	/**
-	 * bind the persistence e.g. to the current thread
+	 * Make the underlying object available via the standard APIs for the underlying
+	 * real ORM implementation. Typically this involves doing something like binding
+	 * the object to the current thread.
 	 */
 	public void bind();
 
 	/**
-	 * unbind the persistence
+	 * Unbind the underlying object, so it is no longer available via the standard
+	 * APIs for the underlying ORM implementation.
 	 */
 	public void unbind();
 
 	/**
-	 * close the persistence, e.g. a underlaying session will be closed
+	 * Close the underlying persistence context.
 	 */
 	public void close();
 }