javadoc update to lock service

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21330 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/lock/LockService.java

@@ -39,9 +39,9 @@ public interface LockService
     * Places a lock on a node.  
     * <p>
     * The lock prevents any other user or process from comitting updates 
-    * to the node untill the lock is released.  
+    * to the node until the lock is released.  
     * <p>
-    * The user reference passed indicates who the owner of the lock is.
+    * The lock will be owned by the current user.
     * <p>
     * A lock made with this call will never expire.
     * 
@@ -59,9 +59,9 @@ public interface LockService
     * Places a lock on a node.  
     * <p>
     * The lock prevents any other user or process from comitting updates 
-    * to the node untill the lock is released.  
+    * to the node until the lock is released.  
     * <p>
-    * The user reference passed indicates who the owner of the lock is.
+    * The lock will be owned by the current user.
     * <p>
     * If the time to expire is 0 then the lock will never expire.  Otherwise the
     * timeToExpire indicates the number of seconds before the lock expires.  When
@@ -71,7 +71,6 @@ public interface LockService
     * be renewed with the passed timeToExpire.
     * 
     * @param  nodeRef       a reference to a node 
-    * @param  userName      a reference to the user that will own the lock
     * @param  lockType      the lock type
     * @param  timeToExpire  the number of seconds before the locks expires.
     * @throws UnableToAquireLockException
@@ -85,9 +84,10 @@ public interface LockService
     * Places a lock on a node and optionally on all its children.  
     * <p>
     * The lock prevents any other user or process from comitting updates 
-    * to the node untill the lock is released.  
+    * to the node until the lock is released.  
     * <p>
-    * The user reference passed indicates who the owner of the lock(s) is.  
+    * The lock will be owned by the current user.
+    * <p>  
     * If any one of the child locks can not be taken then an exception will 
     * be raised and all locks canceled.
     * <p>
@@ -99,7 +99,6 @@ public interface LockService
     * be renewed with the passed timeToExpire.
     * 
     * @param nodeRef            a reference to a node
-    * @param userName           a reference to the user that will own the lock(s)
     * @param lockType           the lock type 
     * @param timeToExpire       the number of seconds before the locks expires.
     * @param lockChildren       if true indicates that all the children (and 
@@ -117,21 +116,18 @@ public interface LockService
     * Places a lock on all the nodes referenced in the passed list.  
     * <p>
     * The lock prevents any other user or process from comitting updates 
-    * to the node untill the lock is released.  
+    * to the node until the lock is released.  
     * <p>
-    * The user reference passed indicates who the owner of the lock(s) is.  
+    * The lock will be owned by the current user.
-    * If any one of the child locks can not be taken then an exception will 
-    * be raised and all locks canceled.
     * <p>
     * If the time to expire is 0 then the lock will never expire.  Otherwise the
     * timeToExpire indicates the number of seconds before the lock expires.  When
     * a lock expires the lock is considered to have been released.
     * <p>
-    * If the node is already locked and the user is the lock owner then the lock will
+    * If the node is already locked and the current user is the lock owner then the lock will
     * be renewed with the passed timeToExpire.
     * 
     * @param  nodeRefs          a list of node references
-    * @param  userName          a reference to the user that will own the lock(s)
     * @param  lockType          the type of lock being created
     * @param  timeToExpire      the number of seconds before the locks expires.
     * @throws UnableToAquireLockException
@@ -148,7 +144,6 @@ public interface LockService
     * owner of the lock or have admin rights) otherwise an exception will be raised. 
     * 
     * @param  nodeRef  a reference to a node
-    * @param  userName  the user reference
     * @throws UnableToReleaseLockException
     *                  thrown if the lock could not be released             
     */
@@ -170,7 +165,6 @@ public interface LockService
     * exception will be raised.
     * 
     * @param  nodeRef        a node reference
-    * @param  userName        the user reference
     * @param  lockChildren   if true then all the children (and grandchildren, etc) 
     *                        of the node will also be unlocked, false otherwise
     * @throws UnableToReleaseLockException

source/java/org/alfresco/service/cmr/lock/package-info.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+/**
+ * Provides the public interface for the invitation service that is used 
+ * to invite users to sites.   
+ * <p>
+ * Two types of invitation are provided,  Nominated invitations, where a user 
+ * nominates another user to become a member of a site and moderated invitations where a user askes to become a member of a site and 
+ * its then up to an administrator to either accept or reject the invitation.
+ */
+package org.alfresco.service.cmr.lock;