svn commit: r566984 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationRequestParameterProvider.java

[sk...@apache.org]

Author: skitching
Date: Fri Aug 17 02:45:59 2007
New Revision: 566984

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

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationRequestParameterProvider.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationRequestParameterProvider.java?view=diff&rev=566984&r1=566983&r2=566984
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationRequestParameterProvider.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationRequestParameterProvider.java Fri Aug 17 02:45:59 2007
@@ -23,7 +23,14 @@
 import org.apache.myfaces.orchestra.requestParameterProvider.RequestParameterProvider;
 
 /**
- * adds the required fields (conversationContext) to the request parameters.
+ * Adds the required fields (conversationContext) to the request parameters.
+ * <p>
+ * This ensures that when the current user has more than one conversationContext
+ * active then every URL in the generated page contains the current
+ * conversation context id as a query parameter. This is used to ensure that
+ * when the next request is submitted to the server the correct ConversationContext
+ * is used (ie the set of Conversation objects that are associated with this
+ * particular window).
  */
 public class ConversationRequestParameterProvider implements RequestParameterProvider
 {