jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ju...@apache.org
Subject svn commit: r155815 - incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote
Date Tue, 01 Mar 2005 19:13:16 GMT
Author: jukka
Date: Tue Mar  1 11:13:11 2005
New Revision: 155815

URL: http://svn.apache.org/viewcvs?view=rev&rev=155815
Log:
Added template documentation of the remote methods.

Modified:
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItem.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItemDef.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteLock.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNamespaceRegistry.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNode.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeDef.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeType.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeTypeManager.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteProperty.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemotePropertyDef.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQuery.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryManager.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryResult.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRepository.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRow.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteSession.java
    incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteWorkspace.java

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItem.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItem.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItem.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItem.java Tue Mar  1 11:13:11 2005
@@ -43,64 +43,103 @@
 public interface RemoteItem extends Remote {
 
     /**
-     * @see javax.jcr.Item#getPath()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#getPath() Item.getPath()} method.
+     *
+     * @return item path
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String getPath() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#getName()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#getName() Item.getName()} method.
+     *
+     * @return item name
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String getName() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#getAncestor(int)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#getAncestor(int) Item.getAncestor(int)} method.
+     *
+     * @param level ancestor level
+     * @return ancestor item
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteItem getAncestor(int level)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#getParent()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#getParent() Item.getParent()} method.
+     *
+     * @return parent node
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode getParent() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#getDepth()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#getDepth() Item.getDepth()} method.
+     *
+     * @return item depth
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     int getDepth() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#isNew()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#isNew() Item.isNew()} method.
+     *
+     * @return <code>true</code> if the item is new,
+     *         <code>false</code> otherwise
+     * @throws RemoteException on RMI errors
      */
     boolean isNew() throws RemoteException;
 
     /**
-     * @see javax.jcr.Item#isModified()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#isModified() Item.isModified()} method.
+     *
+     * @return <code>true</code> if the item is modified,
+     *         <code>false</code> otherwise
+     * @throws RemoteException on RMI errors
      */
     boolean isModified() throws RemoteException;
 
     /**
-     * @see javax.jcr.Item#save()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#save() Item.save()} method.
+     *
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void save() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#refresh(boolean)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#refresh(boolean) Item.refresh(boolean)} method.
+     *
+     * @param keepChanges flag to keep transient changes
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void refresh(boolean keepChanges)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Item#remove()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Item#remove() Item.remove()} method.
+     *
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void remove() throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItemDef.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItemDef.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItemDef.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteItemDef.java Tue Mar  1 11:13:11 2005
@@ -44,37 +44,63 @@
 public interface RemoteItemDef extends Remote {
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#getDeclaringNodeType()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#getDeclaringNodeType() ItemDef.getDeclaringNodeType()}
+     * method.
+     *
+     * @return declaring node type
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType getDeclaringNodeType() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#getName()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#getName() ItemDef.getName()} method.
+     *
+     * @return item name
      * @throws RemoteException on RMI errors
      */
     String getName() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#isAutoCreate()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#isAutoCreate() ItemDef.isAutoCreate()}
+     * method.
+     *
+     * @return <code>true</code> if the item is automatically created,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isAutoCreate() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#isMandatory()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#isMandatory() ItemDef.isMandatory()}
+     * method.
+     *
+     * @return <code>true</code> if the item is mandatory,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isMandatory() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#getOnParentVersion()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#getOnParentVersion() ItemDef.getOnParentVersion()}
+     * method.
+     *
+     * @return parent version behaviour
      * @throws RemoteException on RMI errors
      */
     int getOnParentVersion() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.ItemDef#isProtected()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.ItemDef#isProtected() ItemDef.isProtected()}
+     * method.
+     *
+     * @return <code>true</code> if the item is protected,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isProtected() throws RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteLock.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteLock.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteLock.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteLock.java Tue Mar  1 11:13:11 2005
@@ -41,32 +41,49 @@
 public interface RemoteLock extends Remote {
 
     /**
-     * @see javax.jcr.lock.Lock#getLockOwner()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.lock.Lock#getLockOwner() Lock.getLockOwner()} method.
+     *
+     * @return lock owner
+     * @throws RemoteException on RMI errors
      */
     String getLockOwner() throws RemoteException;
 
     /**
-     * @see javax.jcr.lock.Lock#isDeep()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.lock.Lock#isDeep() Lock.isDeep()} method.
+     *
+     * @return <code>true</code> if the lock is deep,
+     *         <code>false</code> otherwise
+     * @throws RemoteException on RMI errors
      */
     boolean isDeep() throws RemoteException;
 
     /**
-     * @see javax.jcr.lock.Lock#getLockToken()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.lock.Lock#getLockToken() Lock.getLockToken()} method.
+     *
+     * @return lock token
+     * @throws RemoteException on RMI errors
      */
     String getLockToken() throws RemoteException;
 
     /**
-     * @see javax.jcr.lock.Lock#isLive()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.lock.Lock#isLive() Lock.isLive()} method.
+     *
+     * @return <code>true</code> if the lock is live,
+     *         <code>false</code> otherwise
+     * @throws RemoteException on RMI errors
      */
     boolean isLive() throws RemoteException;
 
     /**
-     * @see javax.jcr.lock.Lock#refresh()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.lock.Lock#refresh() Lock.refresh()} method.
+     *
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void refresh() throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNamespaceRegistry.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNamespaceRegistry.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNamespaceRegistry.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNamespaceRegistry.java Tue Mar  1 11:13:11 2005
@@ -44,39 +44,72 @@
 public interface RemoteNamespaceRegistry extends Remote {
 
     /**
-     * @see javax.jcr.NamespaceRegistry#registerNamespace(java.lang.String,java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#registerNamespace(String,String) NamespaceRegistry.registerNamespace(String,String)}
+     * method.
+     *
+     * @param prefix namespace prefix
+     * @param uri namespace uri
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void registerNamespace(String prefix, String uri)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.NamespaceRegistry#unregisterNamespace(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#unregisterNamespace(String) NamespaceRegistry.unregisterNamespace(String)}
+     * method.
+     *
+     * @param prefix namespace prefix
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void unregisterNamespace(String prefix)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.NamespaceRegistry#getPrefixes()
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#getPrefixes() NamespaceRegistry.getPrefixes()}
+     * method.
+     *
+     * @return namespace prefixes
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String[] getPrefixes() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.NamespaceRegistry#getURIs()
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#getURIs() NamespaceRegistry,getURIs()}
+     * method.
+     *
+     * @return namespace uris
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String[] getURIs() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.NamespaceRegistry#getURI(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#getURI(String) NamespaceRegistry.getURI(String)}
+     * method.
+     *
+     * @param prefix namespace prefix
+     * @return namespace uri
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String getURI(String prefix) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.NamespaceRegistry#getPrefix(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.NamespaceRegistry#getPrefix(String) NamespaceRegistry.getPrefix(String)}
+     * method.
+     *
+     * @param uri namespace uri
+     * @return namespace prefix
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String getPrefix(String uri) throws RepositoryException, RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNode.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNode.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNode.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNode.java Tue Mar  1 11:13:11 2005
@@ -55,255 +55,459 @@
 public interface RemoteNode extends RemoteItem {
 
     /**
-     * @see javax.jcr.Node#addNode(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#addNode(String) Node.addNode(Sring)} method.
+     *
+     * @param path relative path
+     * @return new node
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode addNode(String path) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#addNode(java.lang.String, java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#addNode(String,String) Node.addNode(String,String)}
+     * method.
+     *
+     * @param path relative path
+     * @param type node type name
+     * @return new node
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode addNode(String path, String type)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getProperty(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getProperty(String) Node.getProperty(String)}
+     * method.
+     *
+     * @param path relative path
+     * @return node property
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty getProperty(String path)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getProperties()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getProperties() Node.getProperties()} method.
+     *
+     * @return node properties
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty[] getProperties()
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#getProperties(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getProperties(String) Node.getProperties(String)}
+     * method.
+     *
+     * @param pattern property name pattern
+     * @return matching node properties
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty[] getProperties(String pattern)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getPrimaryItem()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getPrimaryItem() Node.getPrimaryItem()} method.
+     *
+     * @return primary item
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteItem getPrimaryItem() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getUUID()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getUUID() Node.getUUID()} method.
+     *
+     * @return node uuid
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String getUUID() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getReferences()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getReferences() Node.getReferences()} method.
+     *
+     * @return reference properties
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty[] getReferences()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getNodes()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getNodes() Node.getNodes()} method.
+     *
+     * @return child nodes
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode[] getNodes() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getNodes(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getNodes(String) Node.getNodes(String)} method.
+     *
+     * @param pattern node name pattern
+     * @return matching child nodes
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode[] getNodes(String pattern)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#hasNode(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#hasNode(String) Node.hasNode(String)} method.
+     *
+     * @param path relative path
+     * @return <code>true</code> if the identified node exists,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean hasNode(String path) throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#hasProperty(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#hasProperty(String) Node.hasProperty()} method.
+     *
+     * @param path relative path
+     * @return <code>true</code> if the identified property exists,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean hasProperty(String path)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#hasNodes()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#hasNodes() Node.hasNodes()} method.
+     *
+     * @return <code>true</code> if this node has child nodes,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean hasNodes() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#hasProperties()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#hasProperties() Node.hasProperties()} method.
+     *
+     * @return <code>true</code> if this node has properties,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean hasProperties() throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#getPrimaryNodeType()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getPrimaryNodeType() Node.getPrimaryNodeType()}
+     * method.
+     *
+     * @return primary node type
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNodeType getPrimaryNodeType()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getMixinNodeTypes()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getMixinNodeTypes() Node.getMixinNodeTypes()}
+     * method.
+     *
+     * @return mixin node types
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getMixinNodeTypes()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#isNodeType(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#isNodeType(String) Node.isNodeType(String)} method.
+     *
+     * @param type node type name
+     * @return <code>true</code> if this node is an instance of the
+     *         identified type, <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean isNodeType(String type) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getNode(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getNode(String) Node.getNode(String)} method.
+     *
+     * @param path relative path
+     * @return node
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode getNode(String path) throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#orderBefore(java.lang.String, java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#orderBefore(String,String) Node.orderBefore(String,String)}
+     * method.
+     *
+     * @param src source path
+     * @param dst destination path
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void orderBefore(String src, String dst)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#setProperty(java.lang.String, javax.jcr.Value)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#setProperty(String,Value) Node.setProperty(String,Value)}
+     * method.
+     *
+     * @param name property name
+     * @param value property value
+     * @return property
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty setProperty(String name, Value value)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#setProperty(java.lang.String, javax.jcr.Value[])
-     * @throws RemoteException on RMI exceptions
-     */
-    RemoteProperty setProperty(String name, Value[] value)
+     * Remote version of the
+     * {@link javax.jcr.Node#setProperty(String,Value[]) Node.setProperty(String,Value[])}
+     * method.
+     *
+     * @param name property name
+     * @param values property values
+     * @return property
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
+     */
+    RemoteProperty setProperty(String name, Value[] values)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#addMixin(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#addMixin(String) Node.addMixin(String)} method.
+     *
+     * @param name mixin type name
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void addMixin(String name) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#removeMixin(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#removeMixin(String) Node.removeMixin(String)}
+     * method.
+     *
+     * @param name mixin type name
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void removeMixin(String name) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#canAddMixin(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#canAddMixin(String) Node.canAddMixin(String)}
+     * method.
+     *
+     * @param name mixin type name
+     * @return <code>true</code> if the mixin type can be added,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean canAddMixin(String name)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getDefinition()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getDefinition() Node.getDefinition()} method.
+     *
+     * @return node definition
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNodeDef getDefinition() throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#checkout()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#checkout() Node.checkout()} method.
+     *
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void checkout() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#update(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#update(String) Node.update(String)} method.
+     *
+     * @param workspace source workspace name
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void update(String workspace) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#merge(java.lang.String, boolean)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#merge(String,boolean) Node.merge(String,boolean)}
+     * method.
+     *
+     * @param workspace source workspace name
+     * @param bestEffort best effort flag
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void merge(String workspace, boolean bestEffort)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getCorrespondingNodePath(java.lang.String)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getCorrespondingNodePath(String) Node.getCorrespondingNodePath(String)}
+     * method.
+     *
+     * @param workspace workspace name
+     * @return corresponding node path
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String getCorrespondingNodePath(String workspace)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#getIndex()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getIndex() Node.getIndex()} method.
+     *
+     * @return node index
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     int getIndex() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#restore(java.lang.String, boolean)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#restore(String,boolean) Node.restore(String,boolean)}
+     * method.
+     *
+     * @param version version name
+     * @param removeExisting flag to remove conflicting nodes
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void restore(String version, boolean removeExisting)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#restoreByLabel(java.lang.String, boolean)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#restoreByLabel(String,boolean) Node.restoreByLabel(String,boolean)}
+     * method.
+     *
+     * @param label version label
+     * @param removeExisting flag to remove conflicting nodes
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void restoreByLabel(String label, boolean removeExisting)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#unlock()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#unlock() Node.unlock()} method.
+     *
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void unlock() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#holdsLock()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#holdsLock() Node.holdsLock()} method.
+     *
+     * @return <code>true</code> if this node holds a lock,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean holdsLock() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#isLocked()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#isLocked() Node.isLocked()} method.
+     *
+     * @return <code>true</code> if this node is locked,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean isLocked() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#isCheckedOut()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#isCheckedOut() Node.isCheckedOut()} method.
+     *
+     * @return <code>true</code> if this node is checked out,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     boolean isCheckedOut() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#setProperty(java.lang.String, javax.jcr.Value[], int)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#setProperty(String,Value[],int) Node.setProperty(String,Value[],int)}
+     * method.
+     *
+     * @param name property name
+     * @param values property values
+     * @param type property type
+     * @return property
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteProperty setProperty(String name, Value[] values, int type)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Node#lock(boolean, boolean)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#lock(boolean,boolean) Node.lock(boolean,boolean)}
+     * method.
+     *
+     * @param isDeep flag to create a deep lock
+     * @param isSessionScoped flag to create a session-scoped lock
+     * @return lock
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteLock lock(boolean isDeep, boolean isSessionScoped)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Node#getLock()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Node#getLock() Node.getLock()} method.
+     *
+     * @return lock
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteLock getLock() throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeDef.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeDef.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeDef.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeDef.java Tue Mar  1 11:13:11 2005
@@ -42,19 +42,32 @@
 public interface RemoteNodeDef extends RemoteItemDef {
 
     /**
-     * @see javax.jcr.nodetype.NodeDef#getRequiredPrimaryTypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeDef#getRequiredPrimaryTypes() NodeDef.getRequiredPrimaryTypes()}
+     * method.
+     *
+     * @return required primary node types
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getRequiredPrimaryTypes() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeDef#getDefaultPrimaryType()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeDef#getDefaultPrimaryType() NodeDef.getDefaultPrimaryType()}
+     * method.
+     *
+     * @return default primary node type
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType getDefaultPrimaryType() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeDef#allowSameNameSibs()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeDef#allowSameNameSibs() NodeDef.allowSameNameSibs()}
+     * method.
+     *
+     * @return <code>true</code> if same name siblings are allowed,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean allowSameNameSibs() throws RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeType.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeType.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeType.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeType.java Tue Mar  1 11:13:11 2005
@@ -44,97 +44,176 @@
 public interface RemoteNodeType extends Remote {
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getName()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getName() NodeType.getName()} method.
+     *
+     * @return node type name
      * @throws RemoteException on RMI errors
      */
     String getName() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#isMixin()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#isMixin() NodeType.isMixin()} method.
+     *
+     * @return <code>true</code> if this is a mixin type,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isMixin() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#hasOrderableChildNodes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#hasOrderableChildNodes() NodeType.hasOrderableChildNodes()}
+     * method.
+     *
+     * @return <code>true</code> if nodes of this type has orderable
+     *         child nodes, <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean hasOrderableChildNodes() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getSupertypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getSupertypes() NodeType.getSupertypes()}
+     * method.
+     *
+     * @return supertypes
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getSupertypes() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getDeclaredSupertypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getDeclaredSupertypes() NodeType.getDeclaredSupertypes()}
+     * method.
+     *
+     * @return declared supertypes
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getDeclaredSupertypes() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#isNodeType(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#isNodeType(String) NodeType.isNodeType(String)}
+     * method.
+     *
+     * @param type node type name
+     * @return <code>true</code> if this node type is or extends the
+     *         given node type, <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isNodeType(String type) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getPropertyDefs()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getPropertyDefs() NodeType.getPropertyDefs()}
+     * method.
+     *
+     * @return property definitions
      * @throws RemoteException on RMI errors
      */
     RemotePropertyDef[] getPropertyDefs() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getDeclaredPropertyDefs()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getDeclaredPropertyDefs() NodeType.getDeclaredPropertyDefs()}
+     * method.
+     *
+     * @return declared property definitions
      * @throws RemoteException on RMI errors
      */
     RemotePropertyDef[] getDeclaredPropertyDefs() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getChildNodeDefs()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getChildNodeDefs() NodeType.getChildNodeDefs()}
+     * method.
+     *
+     * @return child node definitions
      * @throws RemoteException on RMI errors
      */
     RemoteNodeDef[] getChildNodeDefs() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getDeclaredChildNodeDefs()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getDeclaredChildNodeDefs() NodeType.getDeclaredChildNodeDefs()}
+     * method.
+     *
+     * @return declared child node definitions
      * @throws RemoteException on RMI errors
      */
     RemoteNodeDef[] getDeclaredChildNodeDefs() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#canSetProperty(java.lang.String, javax.jcr.Value)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#canSetProperty(String,Value) NodeType.canSetProperty(String,Value)}
+     * method.
+     *
+     * @param name property name
+     * @param value property value
+     * @return <code>true</code> if the property can be set,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean canSetProperty(String name, Value value) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#canSetProperty(java.lang.String, javax.jcr.Value[])
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#canSetProperty(String,Value[]) NodeType.canSetProperty(String,Value[])}
+     * method.
+     *
+     * @param name property name
+     * @param values property values
+     * @return <code>true</code> if the property can be set,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean canSetProperty(String name, Value[] values) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#canAddChildNode(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#canAddChildNode(String) NodeType.canAddChildNode(String)}
+     * method.
+     *
+     * @param name child node name
+     * @return <code>true</code> if the child node can be added,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean canAddChildNode(String name) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#canAddChildNode(java.lang.String, java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#canAddChildNode(String,String) NodeType.canAddChildNode(String,String)}
+     * method.
+     *
+     * @param name child node name
+     * @param type child node type
+     * @return <code>true</code> if the child node can be added,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean canAddChildNode(String name, String type) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#canRemoveItem(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#canRemoveItem(String) NodeType.canRemoveItem(String)}
+     * method.
+     *
+     * @param name item name
+     * @return <code>true</code> if the item can be removed,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean canRemoveItem(String name) throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeType#getPrimaryItemName()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeType#getPrimaryItemName() NodeType.getPrimaryItemName()}
+     * method.
+     *
+     * @return primary item name
      * @throws RemoteException on RMI errors
      */
     String getPrimaryItemName() throws RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeTypeManager.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeTypeManager.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeTypeManager.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteNodeTypeManager.java Tue Mar  1 11:13:11 2005
@@ -48,28 +48,49 @@
 public interface RemoteNodeTypeManager extends Remote {
 
     /**
-     * @see javax.jcr.nodetype.NodeTypeManager#getNodeType(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeTypeManager#getNodeType(String) NodeTypeManager.getNodeType(String)}
+     * method.
+     *
+     * @param name node type name
+     * @return node type
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType getNodeType(String name)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeTypeManager#getAllNodeTypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeTypeManager#getAllNodeTypes() NodeTypeManager.getAllNodeTypes()}
+     * method.
+     *
+     * @return all node types
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getAllNodeTypes()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeTypeManager#getPrimaryNodeTypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeTypeManager#getPrimaryNodeTypes() NodeTypeManager.getPrimaryNodeTypes()}
+     * method.
+     *
+     * @return primary node types
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getPrimaryNodeTypes()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.NodeTypeManager#getMixinNodeTypes()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.NodeTypeManager#getMixinNodeTypes() NodeTypeManager.getMixinNodeTypes()}
+     * method.
+     *
+     * @return mixin node types
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNodeType[] getMixinNodeTypes()

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteProperty.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteProperty.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteProperty.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteProperty.java Tue Mar  1 11:13:11 2005
@@ -54,51 +54,88 @@
 public interface RemoteProperty extends RemoteItem {
 
     /**
-     * @see javax.jcr.Property#getValue()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getValue() Property.getValue()} method.
+     *
+     * @return property value
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     Value getValue() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#getValues()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getValues() Property.getValues()} method.
+     *
+     * @return property values
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     Value[] getValues() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#setValue(javax.jcr.Value)
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#setValue(Value) Property.setValue(Value)}
+     * method.
+     *
+     * @param value property value
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void setValue(Value value) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#setValue(javax.jcr.Value[])
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#setValue(Value[]) Property.setValue(Value[])}
+     * method.
+     *
+     * @param values property values
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void setValue(Value[] values) throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#getLength()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getLength() Property.getLength()}
+     * method.
+     *
+     * @return value length
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     long getLength() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#getLengths()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getLengths() Property.getLengths()}
+     * method.
+     *
+     * @return value lengths
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     long[] getLengths() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#getDefinition()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getDefinition() Property.getDefinition()}
+     * method.
+     *
+     * @return property definition
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemotePropertyDef getDefinition()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Property#getType()
-     * @throws RemoteException on RMI exceptions
+     * Remote version of the
+     * {@link javax.jcr.Property#getType() Property.getType()} method.
+     *
+     * @return property type
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     int getType() throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemotePropertyDef.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemotePropertyDef.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemotePropertyDef.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemotePropertyDef.java Tue Mar  1 11:13:11 2005
@@ -48,25 +48,42 @@
 public interface RemotePropertyDef extends RemoteItemDef {
 
     /**
-     * @see javax.jcr.nodetype.PropertyDef#getRequiredType()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.PropertyDef#getRequiredType() PropertyDef.getRequiredType()}
+     * method.
+     *
+     * @return required type
      * @throws RemoteException on RMI errors
      */
     int getRequiredType() throws RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.nodetype.PropertyDef#getValueConstraints() PropertyDef.getValueConstraints()}
+     * method.
+     *
+     * @return value constraints
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.nodetype.PropertyDef#getValueConstraints()
      */
     String[] getValueConstraints() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.PropertyDef#getDefaultValues()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.PropertyDef#getDefaultValues() PropertyDef.getDefaultValues()}
+     * method.
+     *
+     * @return default values
      * @throws RemoteException on RMI errors
      */
     Value[] getDefaultValues() throws RemoteException;
 
     /**
-     * @see javax.jcr.nodetype.PropertyDef#isMultiple()
+     * Remote version of the
+     * {@link javax.jcr.nodetype.PropertyDef#isMultiple() PropertyDef.isMultiple()}
+     * method.
+     *
+     * @return <code>true</code> if the property is multi-valued,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean isMultiple() throws RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQuery.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQuery.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQuery.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQuery.java Tue Mar  1 11:13:11 2005
@@ -40,7 +40,8 @@
      * @see javax.jcr.query.Query#execute()
      *
      * @return a <code>QueryResult</code>
-     * @throws javax.jcr.RepositoryException if an error occurs
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteQueryResult execute() throws RepositoryException, RemoteException;
 
@@ -48,6 +49,7 @@
      * @see javax.jcr.query.Query#getStatement()
      *
      * @return the query statement.
+     * @throws RemoteException on RMI errors
      */
     String getStatement() throws RemoteException;
 
@@ -55,6 +57,7 @@
      * @see javax.jcr.query.Query#getLanguage()
      *
      * @return the query language.
+     * @throws RemoteException on RMI errors
      */
     String getLanguage() throws RemoteException;
 
@@ -62,7 +65,8 @@
      * @see javax.jcr.query.Query#getPersistentQueryPath()
      *
      * @return path of the node representing this query.
-     * @throws RepositoryException if another error occurs.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String getPersistentQueryPath() throws RepositoryException, RemoteException;
 
@@ -70,7 +74,8 @@
      * @see javax.jcr.query.Query#save(String)
      *
      * @param absPath path at which to persist this query.
-     * @throws RepositoryException If another error occurs.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     void save(String absPath) throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryManager.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryManager.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryManager.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryManager.java Tue Mar  1 11:13:11 2005
@@ -39,8 +39,11 @@
     /**
      * @see javax.jcr.query.QueryManager#createQuery
      *
-     * @throws RepositoryException if another error occurs
-     * @return A <code>Query</code> object.
+     * @param statement query statement
+     * @param language query language
+     * @return query
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteQuery createQuery(String statement, String language)
             throws RepositoryException, RemoteException;
@@ -49,17 +52,19 @@
      * @see javax.jcr.query.QueryManager#getQuery
      *
      * @param absPath node path of a persisted query (that is, a node of type <code>nt:query</code>).
-     * @throws RepositoryException if another error occurs
      * @return a <code>Query</code> object.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteQuery getQuery(String absPath)
             throws RepositoryException, RemoteException;
 
     /**
-     * * @see javax.jcr.query.QueryManager#getSupportedQueryLanguages
+     * @see javax.jcr.query.QueryManager#getSupportedQueryLanguages
      *
      * See {@link Query}.
      * @return An string array.
+     * @throws RemoteException on RMI errors
      */
     String[] getSupportedQueryLanguages() throws RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryResult.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryResult.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryResult.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteQueryResult.java Tue Mar  1 11:13:11 2005
@@ -39,7 +39,8 @@
      * @see javax.jcr.query.QueryResult#getPropertyNames()
      *
      * @return a <code>PropertyIterator</code>
-     * @throws RepositoryException if an error occurs.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     String[] getPropertyNames() throws RepositoryException, RemoteException;
 
@@ -47,7 +48,8 @@
      * @see javax.jcr.query.QueryResult#getRows()
      *
      * @return a <code>RowIterator</code>
-     * @throws RepositoryException if an error occurs.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteRow[] getRows() throws RepositoryException, RemoteException;
 
@@ -55,7 +57,8 @@
      * @see javax.jcr.query.QueryResult#getNodes()
      *
      * @return a <code>NodeIterator</code>
-     * @throws RepositoryException if an error occurs.
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     RemoteNode[] getNodes() throws RepositoryException, RemoteException;
 

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRepository.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRepository.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRepository.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRepository.java Tue Mar  1 11:13:11 2005
@@ -46,50 +46,72 @@
 public interface RemoteRepository extends Remote {
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#getDescriptor(String) Repository.getDescriptor(String)}
+     * method.
+     *
+     * @param key descriptor key
      * @return descriptor value
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#getDescriptor(java.lang.String)
      */
-    String getDescriptor(String name) throws RemoteException;
+    String getDescriptor(String key) throws RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#getDescriptorKeys() Repository.getDescriptorKeys()}
+     * method.
+     *
      * @return descriptor keys
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#getDescriptorKeys()
      */
     String[] getDescriptorKeys() throws RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#login() Repository.login(}} method.
+     *
      * @return remote session
      * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#login()
      */
     RemoteSession login() throws RepositoryException, RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#login(String) Repository.login(String}}
+     * method.
+     *
+     * @param workspace workspace name
      * @return remote session
      * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#login(java.lang.String)
      */
     RemoteSession login(String workspace)
             throws RepositoryException, RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#login(Credentials) Repository.login(Credentials}}
+     * method.
+     *
+     * @param credentials client credentials
      * @return remote session
      * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#login(javax.jcr.Credentials)
      */
     RemoteSession login(Credentials credentials)
             throws RepositoryException, RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Repository#login(Credentials,String) Repository.login(Credentials,String}}
+     * method.
+     *
+     * @param credentials client credentials
+     * @param workspace workspace name
      * @return remote session
      * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
-     * @see javax.jcr.Repository#login(javax.jcr.Credentials, java.lang.String)
      */
     RemoteSession login(Credentials credentials, String workspace)
             throws RepositoryException, RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRow.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRow.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRow.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteRow.java Tue Mar  1 11:13:11 2005
@@ -40,16 +40,19 @@
     /**
      * @see javax.jcr.query.Row#getValues()
      *
-     * @return a <code>Value</code> array.
-     * @throws RepositoryException if an error occurs
+     * @return row values
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     Value[] getValues() throws RepositoryException, RemoteException;
 
     /**
      * @see javax.jcr.query.Row#getValue(String)
      *
-     * @return a <code>Value</code>
-     * @throws RepositoryException if anopther error occurs.
+     * @param propertyName property name
+     * @return identified value
+     * @throws RepositoryException on repository errors
+     * @throws RemoteException on RMI errors
      */
     Value getValue(String propertyName)
             throws RepositoryException, RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteSession.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteSession.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteSession.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteSession.java Tue Mar  1 11:13:11 2005
@@ -48,8 +48,12 @@
 public interface RemoteSession extends Remote {
 
     /**
-     * @see javax.jcr.Session#getUserId()
+     * Remote version of the
+     * {@link javax.jcr.Session#getUserId() Session.getUserId()} method.
+     *
+     * @return user id
      * @throws RemoteException on RMI errors
+     * @see javax.jcr.Session#getUserId()
      */
     String getUserId() throws RemoteException;
 
@@ -60,89 +64,156 @@
      * to access the returned value. Failures to meet these conditions
      * are signalled with RemoteExceptions.
      *
-     * @see javax.jcr.Session#getAttribute(java.lang.String)
+     * @param name attribute name
+     * @return attribute value
      * @throws RemoteException on RMI errors
+     * @see javax.jcr.Session#getAttribute(java.lang.String)
      */
     Object getAttribute(String name) throws RemoteException;
 
     /**
-     * @see javax.jcr.Session#getAttributeNames()
+     * Remote version of the
+     * {@link javax.jcr.Session#getAttributeNames() Session.getAttributeNames()}
+     * method.
+     *
+     * @return attribute names
      * @throws RemoteException on RMI errors
      */
     String[] getAttributeNames() throws RemoteException;
 
     /**
+     * Remote version of the
+     * {@link javax.jcr.Session#getWorkspace() Session.getWorkspace()} method.
+     *
+     * @return workspace
      * @see javax.jcr.Session#getWorkspace()
      * @throws RemoteException on RMI errors
      */
     RemoteWorkspace getWorkspace() throws RemoteException;
 
     /**
-     * @see javax.jcr.Session#impersonate(javax.jcr.Credentials)
+     * Remote version of the
+     * {@link javax.jcr.Session#impersonate(Credentials) Session.impersonate(Credentials)}
+     * method.
+     *
+     * @param credentials credentials for the new session
+     * @return new session
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteSession impersonate(Credentials credentials)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Session#getNodeByUUID(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#getNodeByUUID(String) Session.getNodeByUUID(String)}
+     * method.
+     *
+     * @param uuid node uuid
+     * @return node
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNode getNodeByUUID(String uuid)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Session#getItem(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#getItem(String) Session.getItem(String)}
+     * method.
+     *
+     * @param path item path
+     * @return item
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteItem getItem(String path) throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#itemExists(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#itemExists(String) Session.itemExists(String)}
+     * method.
+     *
+     * @param path item path
+     * @return <code>true</code> if the item exists,
+     *         <code>false</code> otherwise
      * @throws RemoteException on RMI errors
      */
     boolean itemExists(String path) throws RemoteException;
 
     /**
-     * @see javax.jcr.Session#move(java.lang.String, java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#move(String,String) Session.move(String,String)}
+     * method.
+     *
+     * @param from source path
+     * @param to destination path
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void move(String from, String to)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Session#save()
+     * Remote version of the
+     * {@link javax.jcr.Session#save() Session.save()} method.
+     *
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void save() throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#refresh(boolean)
+     * Remote version of the
+     * {@link javax.jcr.Session#refresh(boolean) Session.refresh(boolean)}
+     * method.
+     *
+     * @param keepChanges flag to keep transient changes
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void refresh(boolean keepChanges)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#logout()
+     * Remote version of the
+     * {@link javax.jcr.Session#logout() Session.logout()}
+     * method.
+     *
      * @throws RemoteException on RMI errors
      */
     void logout() throws RemoteException;
 
     /**
-     * @see javax.jcr.Session#getRootNode()
+     * Remote version of the
+     * {@link javax.jcr.Session#getRootNode() Session.getRootNode()} method.
+     *
+     * @return root node
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNode getRootNode() throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#hasPendingChanges()
+     * Remote version of the
+     * {@link javax.jcr.Session#hasPendingChanges() Session.hasPendingChanges()}
+     * method.
+     *
+     * @return <code>true</code> if the session has pending changes,
+     *         <code>false</code> otherwise
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     boolean hasPendingChanges() throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Session#checkPermission(java.lang.String, java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#checkPermission(String,String) Session.checkPermission(String,String)}
+     * method.
+     *
+     * @param path item path
+     * @param actions actions
+     * @throws AccessControlException if permission is denied
      * @throws RemoteException on RMI errors
      */
     void checkPermission(String path, String actions)
@@ -155,54 +226,93 @@
      * large XML streams. The remote server will wrap the XML data into
      * a {@link java.io.ByteArrayInputStream ByteArrayInputStream} and feed
      * it to the normal importXML method.
-     * 
-     * @see javax.jcr.Session#importXML(java.lang.String, java.io.InputStream)
+     *
+     * @param path node path
+     * @param xml imported XML document
+     * @throws IOException on IO errors
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
+     * @see javax.jcr.Session#importXML(java.lang.String, java.io.InputStream)
      */
     void importXML(String path, byte[] xml)
             throws IOException, RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#setNamespacePrefix(java.lang.String, java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#setNamespacePrefix(String,String) Session.setNamespacePrefix(String,String)}
+     * method.
+     *
+     * @param prefix namespace prefix
+     * @param uri namespace uri
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void setNamespacePrefix(String prefix, String uri)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#getNamespacePrefixes()
+     * Remote version of the
+     * {@link javax.jcr.Session#getNamespacePrefixes() Session.getNamespacePrefixes()}
+     * method.
+     *
+     * @return namespace prefixes
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String[] getNamespacePrefixes() throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#getNamespaceURI(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#getNamespaceURI(String) Session.getNamespaceURI(String)}
+     * method.
+     *
+     * @param prefix namespace prefix
+     * @return namespace uri
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String getNamespaceURI(String prefix)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#getNamespacePrefix(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#getNamespacePrefix(String) Session.getNamespacePrefix(String)}
+     * method.
+     *
+     * @param uri namespace uri
+     * @return namespace prefix
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String getNamespacePrefix(String uri)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#addLockToken(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#addLockToken(String) Session.addLockToken(String)}
+     * method.
+     *
+     * @param name lock token
      * @throws RemoteException on RMI errors
      */
     void addLockToken(String name) throws RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#getLockTokens()
+     * Remote version of the
+     * {@link javax.jcr.Session#getLockTokens() Session.getLockTokens()}
+     * method.
+     *
+     * @return lock tokens
      * @throws RemoteException on RMI errors
      */
     String[] getLockTokens() throws RemoteException;
-    
+
     /**
-     * @see javax.jcr.Session#removeLockToken(java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Session#removeLockToken(String) Session.removeLockToken(String)}
+     * method.
+     *
+     * @param name lock token
      * @throws RemoteException on RMI errors
      */
     void removeLockToken(String name) throws RemoteException;
@@ -215,8 +325,14 @@
      * {@link java.io.ByteArrayOutputStream ByteArrayOutputStream} to capture
      * the XML data written by the normal exportSysView method.
      *
-     * @see javax.jcr.Workspace#exportSysView(java.lang.String, java.io.OutputStream, boolean, boolean)
+     * @param path node path
+     * @param binaryAsLink TODO
+     * @param noRecurse TODO
+     * @return exported XML document
+     * @throws IOException on IO errors
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
+     * @see javax.jcr.Workspace#exportSysView(java.lang.String, java.io.OutputStream, boolean, boolean)
      */
     byte[] exportSysView(String path, boolean binaryAsLink, boolean noRecurse)
             throws IOException, RepositoryException, RemoteException;
@@ -229,8 +345,14 @@
      * {@link java.io.ByteArrayOutputStream ByteArrayOutputStream} to capture
      * the XML data written by the normal exportDocView method.
      *
-     * @see javax.jcr.Workspace#exportDocView(java.lang.String, java.io.OutputStream, boolean, boolean)
+     * @param path node path
+     * @param binaryAsLink TODO
+     * @param noRecurse TODO
+     * @return exported XML document
+     * @throws IOException on IO errors
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
+     * @see javax.jcr.Workspace#exportDocView(java.lang.String, java.io.OutputStream, boolean, boolean)
      */
     byte[] exportDocView(String path, boolean binaryAsLink, boolean noRecurse)
         throws IOException, RepositoryException, RemoteException;

Modified: incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteWorkspace.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteWorkspace.java?view=diff&r1=155814&r2=155815
==============================================================================
--- incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteWorkspace.java (original)
+++ incubator/jackrabbit/trunk/contrib/jcr-rmi/src/java/org/apache/jackrabbit/rmi/remote/RemoteWorkspace.java Tue Mar  1 11:13:11 2005
@@ -46,69 +46,127 @@
 public interface RemoteWorkspace extends Remote {
 
     /**
-     * @see javax.jcr.Workspace#getName()
+     * Remote version of the
+     * {@link javax.jcr.Workspace#getName() Workspace.getName()} method.
+     *
+     * @return workspace name
      * @throws RemoteException on RMI errors
      */
     String getName() throws RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#copy(java.lang.String,java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Workspace#copy(String,String) Workspace.copy(String,String)}
+     * method.
+     *
+     * @param from source path
+     * @param to destination path
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void copy(String from, String to)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#copy(java.lang.String,java.lang.String,java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Workspace#copy(String,String,String) Workspace.copy(String,String,String)}
+     * method.
+     *
+     * @param workspace source workspace
+     * @param from source path
+     * @param to destination path
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
-    void copy(String from, String to, String workspace)
+    void copy(String workspace, String from, String to)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#clone(java.lang.String, java.lang.String, java.lang.String, boolean)
+     * Remote version of the
+     * {@link javax.jcr.Workspace#clone(String,String,String,boolean) Workspace.clone(String,String,String,boolean)}
+     * method.
+     *
+     * @param workspace source workspace
+     * @param from source path
+     * @param to destination path
+     * @param removeExisting flag to remove existing items
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
-    void clone(String from, String to, String workspace, boolean removeExisting)
+    void clone(String workspace, String from, String to, boolean removeExisting)
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#move(java.lang.String, java.lang.String)
+     * Remote version of the
+     * {@link javax.jcr.Workspace#move(String,String) Workspace.move(String,String)}
+     * method.
+     *
+     * @param from source path
+     * @param to destination path
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void move(String from, String to)
             throws RepositoryException, RemoteException;
-    
+
     /**
-     * @see javax.jcr.Workspace#getNodeTypeManager()
+     * Remote version of the
+     * {@link javax.jcr.Workspace#getNodeTypeManager() Workspace.getNodeTypeManager()}
+     * method.
+     *
+     * @return node type manager
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNodeTypeManager getNodeTypeManager()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#getNamespaceRegistry()
+     * Remote version of the
+     * {@link javax.jcr.Workspace#getNamespaceRegistry() Workspace.getNamespaceRegistry()}
+     * method.
+     *
+     * @return namespace registry
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteNamespaceRegistry getNamespaceRegistry()
             throws RepositoryException, RemoteException;
 
     /**
-     * @seejavax.jcr.Workspace#getQueryManager()
+     * Remote version of the
+     * {@link javax.jcr.Workspace#getQueryManager() Workspace.getQueryManager()}
+     * method.
+     *
+     * @return query manager
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     RemoteQueryManager getQueryManager()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#getAccessibleWorkspaceNames()
+     * Remote version of the
+     * {@link javax.jcr.Workspace#getAccessibleWorkspaceNames() Workspace.getAccessibleWorkspaceNames()}
+     * method.
+     *
+     * @return accessible workspace names
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     String[] getAccessibleWorkspaceNames()
             throws RepositoryException, RemoteException;
 
     /**
-     * @see javax.jcr.Workspace#importXML(java.lang.String, byte[], int)
+     * Remote version of the
+     * {@link javax.jcr.Workspace#importXML(String,java.io.InputStream,int) Workspace.importXML(String,InputStream,int)}
+     * method.
+     *
+     * @param path node path
+     * @param xml imported XML document
+     * @param uuidBehaviour uuid behaviour flag
+     * @throws IOException on IO errors
+     * @throws RepositoryException on repository errors
      * @throws RemoteException on RMI errors
      */
     void importXML(String path, byte[] xml, int uuidBehaviour)



Mime
View raw message