Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


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

source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java

@@ -179,15 +179,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     }
 
     /**
-     * Start the invitation process for a NominatedInvitation
-     * 
-     * @param inviteeUserName Alfresco user name of the invitee
-     * @param resourceType resourceType
-     * @param resourceName
-     * @param inviteeRole
-     * @param serverPath
-     * @param acceptUrl
-     * @param rejectUrl
+     * Start the invitation process for a NominatedInvitation
+     * 
+     * @param inviteeUserName Alfresco user name of the invitee
+     * @param resourceType resourceType
+     * @param resourceName String
+     * @param inviteeRole String
+     * @param serverPath String
+     * @param acceptUrl String
+     * @param rejectUrl String
      * @return the nominated invitation which will contain the invitationId and
      *         ticket which will uniqely identify this invitation for the rest
      *         of the workflow.
@@ -212,14 +212,14 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
                     serverPath, acceptUrl, rejectUrl);
     }
     /**
-     * Start the invitation process for a NominatedInvitation
-     * 
-     * @param inviteeUserName Alfresco user name of the invitee
-     * @param resourceType resourceType
-     * @param resourceName
-     * @param inviteeRole
-     * @param acceptUrl
-     * @param rejectUrl
+     * Start the invitation process for a NominatedInvitation
+     * 
+     * @param inviteeUserName Alfresco user name of the invitee
+     * @param resourceType resourceType
+     * @param resourceName String
+     * @param inviteeRole String
+     * @param acceptUrl String
+     * @param rejectUrl String
      * @return the nominated invitation which will contain the invitationId and
      *         ticket which will uniqely identify this invitation for the rest
      *         of the workflow.
@@ -247,15 +247,14 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * Start the invitation process for a NominatedInvitation
      * 
-     * @param inviteeFirstName
-     * @param inviteeLastName
-     * @param inviteeEmail
-     * @param inviteeEmail
-     * @param resourceType Invitation.ResourceType
-     * @param resourceName
-     * @param inviteeRole
-     * @param acceptUrl
-     * @param rejectUrl
+     * @param inviteeFirstName String
+     * @param inviteeLastName String
+     * @param inviteeEmail String
+     * @param resourceType Invitation.ResourceType
+     * @param resourceName String
+     * @param inviteeRole String
+     * @param acceptUrl String
+     * @param rejectUrl String
      * @return the nominated invitation which will contain the invitationId and
      *         ticket which will uniqely identify this invitation for the rest
      *         of the workflow.
@@ -274,15 +273,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * Start the invitation process for a NominatedInvitation
      * 
-     * @param inviteeFirstName
-     * @param inviteeLastName
-     * @param inviteeEmail
-     * @param resourceType
-     * @param resourceName
-     * @param inviteeRole
-     * @param serverPath
-     * @param acceptUrl
-     * @param rejectUrl
+     * @param inviteeFirstName String
+     * @param inviteeLastName String
+     * @param inviteeEmail String
+     * @param resourceType Invitation.ResourceTyp
+     * @param resourceName String
+     * @param inviteeRole String
+     * @param serverPath String
+     * @param acceptUrl String
+     * @param rejectUrl String
      * @return the nominated invitation which will contain the invitationId and
      *         ticket which will uniqely identify this invitation for the rest
      *         of the workflow.
@@ -316,15 +315,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
         throw new InvitationException("unknown resource type");
     }
 
-    /**
-     * Start the invitation process for a ModeratedInvitation
-     * 
-     * @param inviteeComments why does the invitee want access to the resource ?
-     * @param inviteeUserName who is to be invited
-     * @param resourceType Invitation .ResourceType what resource type ?
-     * @param resourceName which resource
-     * @param inviteeRole which role ?
-     */
+    /**
+     * Start the invitation process for a ModeratedInvitation
+     * 
+     * @param inviteeComments why does the invitee want access to the resource ?
+     * @param inviteeUserName who is to be invited
+     * @param resourceType Invitation .ResourceType what resource type ?
+     * @param resourceName which resource
+     * @param inviteeRole which role ?
+     */
     public ModeratedInvitation inviteModerated(String inviteeComments, String inviteeUserName,
                 Invitation.ResourceType resourceType, String resourceName, String inviteeRole)
     {
@@ -395,13 +394,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
         }
     }
     
-    /**
-     * Moderator approves this invitation
-     * 
-     * @param invitationId the request id
-     * @param reason comments about the acceptance
-     */
-    public Invitation approve(String invitationId, String reason)
+    /**
+     * Moderator approves this invitation
+     * 
+     * @param invitationId the request id
+     * @param reason comments about the acceptance
+     */
+    public Invitation approve(String invitationId, String reason)
     {
         WorkflowTask startTask = getStartTask(invitationId);
         ModeratedInvitation invitation = getModeratedInvitation(invitationId);
@@ -427,7 +426,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * User or moderator rejects this request
      * 
-     * @param invitationId
+     * @param invitationId String
      * @param reason , optional reason for rejection
      */
     public Invitation reject(String invitationId, String reason)
@@ -718,8 +717,8 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * list Invitations for a specific resource
      * 
-     * @param resourceType
-     * @param resourceName
+     * @param resourceType Invitation.ResourceType
+     * @param resourceName String
      */
     public List<Invitation> listPendingInvitationsForResource(Invitation.ResourceType resourceType, String resourceName)
     {
@@ -729,8 +728,8 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
 
     /**
      * Returns search criteria to find pending invitations
-     * @param resourceType
-     * @param resourceName
+     * @param resourceType Invitation.ResourceType
+     * @param resourceName String
      * @return search criteria
      */
     private InvitationSearchCriteriaImpl getPendingInvitationCriteriaForResource(
@@ -746,7 +745,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * This is the general search invitation method returning {@link Invitation}s
      * 
-     * @param criteria
+     * @param criteria InvitationSearchCriteria
      * @return the list of start tasks for invitations
      */
     public List<Invitation> searchInvitation(final InvitationSearchCriteria criteria)
@@ -777,7 +776,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * This is a general search invitation method returning IDs
      * 
-     * @param criteria
+     * @param criteria InvitationSearchCriteria
      * @param limit maximum number of IDs to return. If less than 1, there is no limit. 
      * @return the list of invitation IDs (the IDs of the invitations not the IDs of the invitation start tasks)
      */
@@ -819,9 +818,9 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
 
     /**
      * Fix for ALF-2598
-     * @param invitation
-     * @param criteria
-     * @return
+     * @param invitation Invitation
+     * @param criteria InvitationSearchCriteria
+     * @return boolean
      */
     private boolean invitationMatches(Invitation invitation, InvitationSearchCriteria criteria)
     {
@@ -984,7 +983,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * Set the workflow service
      * 
-     * @param workflowService
+     * @param workflowService WorkflowService
      */
     public void setWorkflowService(WorkflowService workflowService)
     {
@@ -1164,7 +1163,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
      * Creates a disabled user account for the given invitee user name with a
      * generated password
      * 
-     * @param inviteeUserName
+     * @param inviteeUserName String
      * @return password generated for invitee user account
      */
     private String createInviteeDisabledAccount(String inviteeUserName)
@@ -1220,22 +1219,22 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     }
 
     /**
-     * Starts the Invite workflow
-     * 
-     * @param inviteeFirstName first name of invitee
-     * @param inviteeLastName last name of invitee
-     * @param inviteeEmail email address of invitee
-     * @param siteShortName short name of site that the invitee is being invited
-     *            to by the inviter
+     * Starts the Invite workflow
+     * 
+     * @param inviteeFirstName first name of invitee
+     * @param inviteeLastName last name of invitee
+     * @param inviteeEmail email address of invitee
+     * @param siteShortName short name of site that the invitee is being invited
+     *            to by the inviter
      * @param inviteeSiteRole role under which invitee is being invited to the
-     *            site by the inviter
-     * @param serverPath externally accessible server address of server hosting
-     *            invite web scripts
-     * @param acceptUrl accept Url
-     * @param rejectUrl reject Url
-     */
-    private NominatedInvitation startNominatedInvite(String inviteeFirstName, String inviteeLastName,
-                String inviteeEmail, String inviteeUserName, Invitation.ResourceType resourceType,
+     *            site by the inviter
+     * @param serverPath externally accessible server address of server hosting
+     *            invite web scripts
+     * @param acceptUrl accept Url
+     * @param rejectUrl reject Url
+     */
+    private NominatedInvitation startNominatedInvite(String inviteeFirstName, String inviteeLastName,
+                String inviteeEmail, String inviteeUserName, Invitation.ResourceType resourceType,
                 String siteShortName, String inviteeSiteRole, String serverPath, String acceptUrl, String rejectUrl)
     {
 
@@ -1491,7 +1490,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * Return Activiti workflow definition unless Activiti engine is disabled.
      * @param isNominated TODO
-     * @return
+     * @return WorkflowDefinition
      */
     private WorkflowDefinition getWorkflowDefinition(boolean isNominated)
     {
@@ -1532,13 +1531,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
         throw new IllegalStateException("None of the Workflow engines supported by teh InvitationService are currently enabled!");
     }
 
-    /**
-     * Check that the specified user has manager role over the resource.
-     * 
-     * @param userId user id
-     * @throws InvitationException
-     */
-    private void checkManagerRole(String userId, Invitation.ResourceType resourceType, String siteShortName)
+    /**
+     * Check that the specified user has manager role over the resource.
+     * 
+     * @param userId user id
+     * @throws InvitationException
+     */
+    private void checkManagerRole(String userId, Invitation.ResourceType resourceType, String siteShortName)
     {
         // if inviter is not the site manager then throw web script exception
         String inviterRole = this.siteService.getMembersRole(siteShortName, userId);
@@ -1553,7 +1552,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
     /**
      * Validator for invitationId
      * 
-     * @param invitationId
+     * @param invitationId String
      */
     private void validateInvitationId(String invitationId)
     {