[Wonder-cvs] CVS: ProjectWonder/Frameworks/ERExtensionsJava ERXSession.java,1.6,1.7

[Max M. <max...@us...>]

Update of /cvsroot/wonder/ProjectWonder/Frameworks/ERExtensionsJava
In directory usw-pr-cvs1:/tmp/cvs-serv10270

Modified Files:
	ERXSession.java 
Log Message:
some JavaDoc

Index: ERXSession.java
===================================================================
RCS file: /cvsroot/wonder/ProjectWonder/Frameworks/ERExtensionsJava/ERXSession.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** ERXSession.java	16 Apr 2002 19:47:51 -0000	1.6
--- ERXSession.java	7 May 2002 18:29:39 -0000	1.7
***************
*** 252,261 ****
      }
  
!     // Subclasses override this method to provide their own navigation abilities
      public ERXNavigation createNavigation() { return new ERXNavigation(); }
      public ERXNavigation erxNavigation() { return _navigation; }
! 
      protected boolean _hideHelp=false;
      public boolean hideHelp() { return _hideHelp; }
      public void setHideHelp(boolean newValue) { _hideHelp=newValue; }
  
--- 252,264 ----
      }
  
!     // CHECKME: Should be removed
      public ERXNavigation createNavigation() { return new ERXNavigation(); }
+     // CHECKME: Should be removed
      public ERXNavigation erxNavigation() { return _navigation; }
!     // CHECKME: Should be removed
      protected boolean _hideHelp=false;
+     // CHECKME: Should be removed
      public boolean hideHelp() { return _hideHelp; }
+     // CHECKME: Should be removed
      public void setHideHelp(boolean newValue) { _hideHelp=newValue; }
  
***************
*** 273,278 ****
      public boolean lastActionWasDA = false;
      /**
!         * Utility method that gets the context ID string
!      * from the passed in request
       */
      public String requestsContextID(WORequest aRequest){
--- 276,283 ----
      public boolean lastActionWasDA = false;
      /**
!      * Utility method that gets the context ID string
!      * from the passed in request.
!      * @param aRequest request to get the context id from
!      * @return the context id as a string
       */
      public String requestsContextID(WORequest aRequest){
***************
*** 288,295 ****
  
      /**
!         * Method inspects the passed in request to see if
       * the user backtracked. If the context ID for the request is 2 clicks
       * less than the context ID for the current WOContext, we know
       * the backtracked.
       */
      public boolean didBacktrack(WORequest aRequest, WOContext aContext){
--- 293,303 ----
  
      /**
!      * Method inspects the passed in request to see if
       * the user backtracked. If the context ID for the request is 2 clicks
       * less than the context ID for the current WOContext, we know
       * the backtracked.
+      * @param aRequest request to check
+      * @param aContext context to check against request
+      * @return if the user has backtracked or not.
       */
      public boolean didBacktrack(WORequest aRequest, WOContext aContext){
***************
*** 315,347 ****
  
      /**
!         * Overrides the ComponentAction handler to set the didBackTrack
!      * flag
       */
      public WOActionResults invokeAction(WORequest aRequest, WOContext aContext){
          String reqCID = requestsContextID(aRequest);
          didBackTrack = didBacktrack(aRequest, aContext);
!         if (didBackTrack) cat.debug("User backtracking.");
          return super.invokeAction(aRequest, aContext);
      }
  
      public void takeValuesFromRequest (WORequest aRequest, WOContext aContext){
          String reqCID = requestsContextID(aRequest);
          didBackTrack = didBacktrack(aRequest, aContext);
!         if (didBackTrack) cat.debug("User backtracking.");
          super. takeValuesFromRequest (aRequest, aContext);
      }
  
      public void appendToResponse(WOResponse r, WOContext c) {
!         if (didBackTrack) cat.debug("User backtracking.");
          super.appendToResponse(r, c);
      }
  
      public String wrapperPageName() { return "PageWrapper"; }
  
      public void terminate() {
          // work around a bug in WO 5.1.1 where the sessions EC will keep a lock on the SEC
          defaultEditingContext().setSharedEditingContext(null);
          super.terminate();
      }
- 
  }
--- 323,370 ----
  
      /**
!      * Overrides the ComponentAction handler to set the didBackTrack
!      * flag by calling the method <code>didBacktrack</code>/
!      * @param aRequest current request
!      * @param aContext current context
!      * @return super's implementation of <code>invokeAction</code>
       */
      public WOActionResults invokeAction(WORequest aRequest, WOContext aContext){
          String reqCID = requestsContextID(aRequest);
          didBackTrack = didBacktrack(aRequest, aContext);
!         if (didBackTrack) cat.debug("User backtracking in invokeAction.");
          return super.invokeAction(aRequest, aContext);
      }
  
+     /**
+      * Overrides the ComponentAction handler to set the didBackTrack
+      * flag by calling the method <code>didBacktrack</code>/
+      * @param aRequest current request
+      * @param aContext current context
+      * @return super's implementation of <code>invokeAction</code>
+      */
      public void takeValuesFromRequest (WORequest aRequest, WOContext aContext){
          String reqCID = requestsContextID(aRequest);
          didBackTrack = didBacktrack(aRequest, aContext);
!         if (didBackTrack) cat.debug("User backtracking in takeValuesFromRequest.");
          super. takeValuesFromRequest (aRequest, aContext);
      }
  
      public void appendToResponse(WOResponse r, WOContext c) {
!         if (didBackTrack) cat.debug("User backtracking in appendToResponse.");
          super.appendToResponse(r, c);
      }
  
+     // CHECKME: Should remove.
      public String wrapperPageName() { return "PageWrapper"; }
  
+     /**
+      * Ovverrides terminate to set the shared editing context of the default
+      * editing context to null to avoid a locking problem in WO 5.1.1.
+      */
      public void terminate() {
+         // WOFIX: 5.1.1
          // work around a bug in WO 5.1.1 where the sessions EC will keep a lock on the SEC
          defaultEditingContext().setSharedEditingContext(null);
          super.terminate();
      }
  }