From d407d528d1f1e8916799f75d4548fa77286f569e Mon Sep 17 00:00:00 2001
From: Andrew Branson <andrew.branson@cern.ch>
Date: Mon, 6 Oct 2014 16:47:35 +0200
Subject: More documentation

---
 .../java/com/c2kernel/entity/TraceableEntity.java  | 39 +++-------------------
 1 file changed, 5 insertions(+), 34 deletions(-)

(limited to 'src/main/java/com/c2kernel/entity/TraceableEntity.java')

diff --git a/src/main/java/com/c2kernel/entity/TraceableEntity.java b/src/main/java/com/c2kernel/entity/TraceableEntity.java
index 7d5df52..f0bf957 100644
--- a/src/main/java/com/c2kernel/entity/TraceableEntity.java
+++ b/src/main/java/com/c2kernel/entity/TraceableEntity.java
@@ -33,9 +33,11 @@ import com.c2kernel.lookup.ItemPath;
 import com.c2kernel.utils.Logger;
 
 /**************************************************************************
-*
-* @author $Author: abranson $ $Date: 2005/10/06 14:46:22 $
-* @version $Revision: 1.108 $
+*  TraceableEntity is the implementation of the CORBA Item, although it 
+*  delegates all non-CORBA functions to ItemImplementation.
+*  
+*  Traditional Pinky/Brain ASCII art:
+*  
 * <pre>
 *                                ,.   '\'\    ,---.
 *                            .  | \\  l\\l_ //    |
@@ -66,9 +68,6 @@ public class TraceableEntity extends ItemPOA
     private final org.omg.PortableServer.POA  mPoa;
     private final ItemImplementation	      mItemImpl;
 
-   /**************************************************************************
-    * Constructor used by the Locator only
-    **************************************************************************/
     public TraceableEntity( ItemPath                   key,
                             org.omg.PortableServer.POA poa )
     {
@@ -78,9 +77,6 @@ public class TraceableEntity extends ItemPOA
     }
 
 
-   /**************************************************************************
-    *
-    **************************************************************************/
     @Override
 	public org.omg.PortableServer.POA _default_POA()
     {
@@ -91,18 +87,12 @@ public class TraceableEntity extends ItemPOA
     }
 
 
-   /**************************************************************************
-    *
-    **************************************************************************/
     @Override
 	public SystemKey getSystemKey()
     {
         return mItemImpl.getSystemKey();
     }
 
-   /**************************************************************************
-    *
-    **************************************************************************/
     @Override
 	public void initialise( SystemKey agentId,
                             String  propString,
@@ -118,11 +108,6 @@ public class TraceableEntity extends ItemPOA
         }
     }
 
-    /**
-     * @throws InvalidCollectionModification 
-     *
-     **************************************************************************/
-	//requestdata is xmlstring
     @Override
 	public String requestAction( SystemKey agentId,
                                String stepPath,
@@ -141,9 +126,6 @@ public class TraceableEntity extends ItemPOA
         }
     }
 
-   /**************************************************************************
-    *
-    **************************************************************************/
     @Override
 	public String queryLifeCycle( SystemKey agentId,
                                   boolean     filter
@@ -157,17 +139,6 @@ public class TraceableEntity extends ItemPOA
         }
     }
 
-   /**************************************************************************
-    * The description for operation getData.
-    *
-    * @param path - the path to the object required
-    * 		  the suffix 'all' retrieves a listing of all keys on that level
-    *
-    * @return The result string in xml format
-	*		   except 'all' which returns a comma sep list
-    *
-    * @exception ObjectNotFoundException
-    * ************************************************************************/
     @Override
 	public String queryData(String path)
         throws AccessRightsException,
-- 
cgit v1.2.3