RM-3150 (Errors when generating Javadoc for RM using Java 8)

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMActionExecuterAbstractBase.java

@@ -27,6 +27,8 @@
 
 package org.alfresco.module.org_alfresco_module_rm.action;
 
+import static org.apache.commons.lang.StringUtils.leftPad;
+
 import java.io.Serializable;
 import java.util.HashSet;
 import java.util.List;
@@ -131,6 +133,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Get the transaction service
+     *
+     * @return The transaction service
      */
     protected TransactionService getTransactionService()
     {
@@ -139,6 +143,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the transaction service
+     *
+     * @param transactionService The transaction service
      */
     public void setTransactionService(TransactionService transactionService)
     {
@@ -147,6 +153,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the namespace service
+     *
+     * @return The namespace service
      */
     protected NamespaceService getNamespaceService()
     {
@@ -155,6 +163,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the namespace service
+     *
+     * @param namespaceService The namespace service
      */
     public void setNamespaceService(NamespaceService namespaceService)
     {
@@ -163,6 +173,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the node service
+     *
+     * @return The node service
      */
     protected NodeService getNodeService()
     {
@@ -170,7 +182,9 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * Set node service
+     * Set the node service
+     *
+     * @param nodeService The node service
      */
     public void setNodeService(NodeService nodeService)
     {
@@ -179,6 +193,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the dictionary service
+     *
+     * @return The dictionary service
      */
     protected DictionaryService getDictionaryService()
     {
@@ -187,6 +203,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the dictionary service
+     *
+     * @param dictionaryService The dictionary service
      */
     public void setDictionaryService(DictionaryService dictionaryService)
     {
@@ -195,6 +213,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the content service
+     *
+     * @return The content service
      */
     protected ContentService getContentService()
     {
@@ -203,6 +223,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the content service
+     *
+     * @param contentService The content service
      */
     public void setContentService(ContentService contentService)
     {
@@ -211,6 +233,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the action service
+     *
+     * @return The action service
      */
     protected ActionService getActionService()
     {
@@ -219,6 +243,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set action service
+     *
+     * @param actionService The action service
      */
     public void setActionService(ActionService actionService)
     {
@@ -227,6 +253,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the records management audit service
+     *
+     * @return The records management audit service
      */
     protected RecordsManagementAuditService getRecordsManagementAuditService()
     {
@@ -235,6 +263,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the audit service that action details will be sent to
+     *
+     * @param recordsManagementAuditService The audit service that action details will be sent to
      */
     public void setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService)
     {
@@ -243,6 +273,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the records management action service
+     *
+     * @return The records management action service
      */
     protected RecordsManagementActionService getRecordsManagementActionService()
     {
@@ -251,6 +283,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set records management service
+     *
+     * @param recordsManagementActionService The records management service
      */
     public void setRecordsManagementActionService(RecordsManagementActionService recordsManagementActionService)
     {
@@ -259,6 +293,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the disposition service
+     *
+     * @return The disposition service
      */
     protected DispositionService getDispositionService()
     {
@@ -267,6 +303,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the disposition service
+     *
+     * @param dispositionService The disposition service
      */
     public void setDispositionService(DispositionService dispositionService)
     {
@@ -275,6 +313,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the vital record service
+     *
+     * @return The vital record service
      */
     protected VitalRecordService getVitalRecordService()
     {
@@ -282,7 +322,9 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * @param vitalRecordService    vital record service
+     * Sets the vital record service
+     *
+     * @param vitalRecordService vital record service
      */
     public void setVitalRecordService(VitalRecordService vitalRecordService)
     {
@@ -291,6 +333,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the records management event service
+     *
+     * @return The records management event service
      */
     protected RecordsManagementEventService getRecordsManagementEventService()
     {
@@ -298,7 +342,9 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * Set records management event service
+     * Set the records management event service
+     *
+     * @param recordsManagementEventService The records management event service
      */
     public void setRecordsManagementEventService(RecordsManagementEventService recordsManagementEventService)
     {
@@ -307,6 +353,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the ownable service
+     *
+     * @return The ownable service
      */
     protected OwnableService getOwnableService()
     {
@@ -315,7 +363,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Set the ownable service
-     * @param ownableSerice
+     *
+     * @param ownableService The ownable service
      */
     public void setOwnableService(OwnableService ownableService)
     {
@@ -324,6 +373,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the freeze service
+     *
+     * @return The freeze service
      */
     protected FreezeService getFreezeService()
     {
@@ -342,6 +393,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the record service
+     *
+     * @return The record service
      */
     protected RecordService getRecordService()
     {
@@ -359,7 +412,9 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * @return  records management admin service
+     * Gets the records management admin service
+     *
+     * @return The records management admin service
      */
     protected RecordsManagementAdminService getRecordsManagementAdminService()
     {
@@ -367,6 +422,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
+     * Sets the records management admin service
+     *
      * @param recordsManagementAdminService records management admin service
      */
     public void setRecordsManagementAdminService(RecordsManagementAdminService recordsManagementAdminService)
@@ -376,6 +433,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the model security service
+     *
+     * @return The model security service
      */
     protected ModelSecurityService getModelSecurityService()
     {
@@ -383,6 +442,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
+     * Sets the model security service
+     *
      * @param modelSecurityService  model security service
      */
     public void setModelSecurityService(ModelSecurityService modelSecurityService)
@@ -392,6 +453,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the record folder service
+     *
+     * @return The record folder service
      */
     protected RecordFolderService getRecordFolderService()
     {
@@ -399,6 +462,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
+     * Sets the record folder service
+     *
      * @param recordFolderService record folder service
      */
     public void setRecordFolderService(RecordFolderService recordFolderService)
@@ -408,6 +473,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
 
     /**
      * Gets the hold service
+     *
+     * @return The hold service
      */
     protected HoldService getHoldService()
     {
@@ -415,6 +482,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
+     * Sets the hold service
+     *
      * @param holdService hold service
      */
     public void setHoldService(HoldService holdService)
@@ -423,6 +492,8 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
+     * Sets the applicable kinds
+     *
      * @param applicableKinds   kinds that this action is applicable for
      */
     public void setApplicableKinds(String[] applicableKinds)
@@ -504,7 +575,7 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAction#getName()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction#getName()
      */
     public String getName()
     {
@@ -546,7 +617,7 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     /**
      * By default an action is not a disposition action
      *
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAction#isDispositionAction()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction#isDispositionAction()
      */
     public boolean isDispositionAction()
     {
@@ -554,7 +625,7 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAction#execute(org.alfresco.service.cmr.repository.NodeRef, java.util.Map)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction#execute(org.alfresco.service.cmr.repository.NodeRef, java.util.Map)
      */
     public RecordsManagementActionResult execute(NodeRef filePlanComponent, Map<String, Serializable> parameters)
     {
@@ -585,19 +656,14 @@ public abstract class RMActionExecuterAbstractBase  extends PropertySubActionExe
      * @param s     String to pad with leading zero '0' characters
      * @param len   Length to pad to
      *
-     * @return padded string or the original if already at >=len characters
+     * @return padded string or the original if already at &gt;= len characters
      *
      * @deprecated As of 2.1, replaced by {@link org.apache.commons.lang.StringUtils.leftPad}
      */
     @Deprecated
     protected String padString(String s, int len)
     {
-       String result = s;
+       return leftPad(s, len);
-       for (int i=0; i<(len - s.length()); i++)
-       {
-           result = "0" + result;
-       }
-       return result;
     }
 
     /**

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMDispositionActionExecuterAbstractBase.java

@@ -73,7 +73,7 @@ public abstract class RMDispositionActionExecuterAbstractBase extends RMActionEx
     /**
      * Indicates whether the disposition is marked complete
      *
-     * @return boolean true if marked complete, false otherwise
+     * @return <code>true</code> if marked complete, <code>false</code> otherwise
      */
     public boolean getSetDispositionActionComplete()
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementAction.java

@@ -72,6 +72,7 @@ public interface RecordsManagementAction
      *
      * @param filePlanComponent     file plan component the action is executed upon
      * @param parameters            action parameters
+     * @return The result of the executed action
      */
     RecordsManagementActionResult execute(NodeRef filePlanComponent, Map<String, Serializable> parameters);
 
@@ -86,7 +87,7 @@ public interface RecordsManagementAction
     /**
      * Get the records management action definition.
      *
-     * @return
+     * @return The records management action definition.
      * @since 2.1
      */
     RecordsManagementActionDefinition getRecordsManagementActionDefinition();
@@ -94,7 +95,7 @@ public interface RecordsManagementAction
     /**
      * Indicates whether the action is public or not
      *
-     * @return
+     * @return <code>true</code> if the action is public, <code>false</code> otherwise
      * @since 2.1
      */
     boolean isPublicAction();

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionCondition.java

@@ -58,13 +58,13 @@ public interface RecordsManagementActionCondition
 
     /**
      *
-     * @return
+     * @return The records management action condition definition
      */
     RecordsManagementActionConditionDefinition getRecordsManagementActionConditionDefinition();
 
     /**
      *
-     * @return
+     * @return <code>true</code> if the condition is public, <code>false</code> otherwise
      */
     boolean isPublicCondition();
 }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionConditionEvaluatorAbstractBase.java

@@ -96,7 +96,7 @@ public abstract class RecordsManagementActionConditionEvaluatorAbstractBase exte
 	}
 
     /**
-     * @param retryingTransactionHelper
+     * @param retryingTransactionHelper retrying transaction helper
      */
     public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)
     {
@@ -150,7 +150,7 @@ public abstract class RecordsManagementActionConditionEvaluatorAbstractBase exte
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAction#getName()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionCondition#getName()
      */
     public String getName()
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionService.java

@@ -36,44 +36,45 @@ import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
  * Records management action service interface
- * 
+ *
  * @author Roy Wetherall
  */
 public interface RecordsManagementActionService
 {
     /**
      * Get a list of the available records management actions
-     * 
+     *
-     * @return  List<RecordsManagementAction>    records management actions
+     * @return List of records management actions
      */
     List<RecordsManagementAction> getRecordsManagementActions();
-    
+
     /**
-     * 
+     *  Get a list of the available records management action conditions
-     * @return
+     *
+     * @return List of records management action conditions
      * @since 2.1
      */
     List<RecordsManagementActionCondition> getRecordsManagementActionConditions();
-    
+
     /**
      * Get a list of the available disposition actions.  A disposition action is a records
      * management action that can be used when defining disposition instructions.
-     * 
+     *
-     * @return List<RecordsManagementAction>     disposition actions
+     * @return List of disposition actions
      */
     List<RecordsManagementAction> getDispositionActions();
-    
+
     /**
      * Gets the named records management action
-     * 
+     *
      * @param name The name of the RM action to retrieve
      * @return The RecordsManagementAction or null if it doesn't exist
      */
     RecordsManagementAction getRecordsManagementAction(String name);
-    
+
     /**
      * Gets the named disposition action
-     * 
+     *
      * @param name The name of the disposition action to retrieve
      * @return The RecordsManagementAction or null if it doesn't exist
      */
@@ -81,57 +82,63 @@ public interface RecordsManagementActionService
 
     /**
      * Execute a records management action
-     * 
+     *
      * @param nodeRef     node reference to a rm container, rm folder or record
      * @param name        action name
+     * @return The result of executed records management action
      */
     RecordsManagementActionResult executeRecordsManagementAction(NodeRef nodeRef, String name);
-    
+
     /**
      * Execute a records management action against several nodes
-     * 
+     *
      * @param nodeRefs  node references to rm containers, rm folders or records
      * @param name      action name
+     * @return The result of executed records management action against several nodes
      */
     Map<NodeRef, RecordsManagementActionResult> executeRecordsManagementAction(List<NodeRef> nodeRefs, String name);
-    
+
     /**
      * Execute a records management action
-     * 
+     *
      * @param nodeRef     node reference to a rm container, rm folder or record
      * @param name        action name
      * @param parameters  action parameters
+     * @return The result of executed records management action
      */
     RecordsManagementActionResult executeRecordsManagementAction(NodeRef nodeRef, String name, Map<String, Serializable> parameters);
 
     /**
      * Execute a records management action against several nodes
-     * 
+     *
      * @param nodeRefs      node references to rm containers, rm folders or records
      * @param name          action name
      * @param parameters    action parameters
+     * @return The result of executed records management action against several nodes
      */
     Map<NodeRef, RecordsManagementActionResult> executeRecordsManagementAction(List<NodeRef> nodeRefs, String name, Map<String, Serializable> parameters);
-    
+
     /**
      * Execute a records management action. The nodeRef against which the action is to be
      * executed must be provided by the RecordsManagementAction implementation.
-     * 
+     *
      * @param name        action name
      * @param parameters  action parameters
+     * @return The result of executed records management action
      */
     RecordsManagementActionResult executeRecordsManagementAction(String name, Map<String, Serializable> parameters);
 
     /**
      * Register records management action
-     * 
+     *
      * @param rmAction  records management action
      */
     void register(RecordsManagementAction rmAction);
-    
+
     /**
-     * 
+     * Register records management condition
-     * @param rmCondition
+     *
+     * @param rmCondition records management condition
      * @since 2.1
      */
     void register(RecordsManagementActionCondition rmCondition);

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionServiceImpl.java

@@ -125,7 +125,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#register(org.alfresco.module.org_alfresco_module_rm.RecordsManagementAction)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#register(org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction)
      */
     public void register(RecordsManagementAction rmAction)
     {
@@ -181,7 +181,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#getRecordsManagementActions()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#getRecordsManagementActions()
      */
     public List<RecordsManagementAction> getRecordsManagementActions()
     {
@@ -202,7 +202,10 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#getDispositionActions(org.alfresco.service.cmr.repository.NodeRef)
+     * Gets the disposition actions for the given node
+     *
+     * @param nodeRef The node reference
+     * @return List of records management action
      */
     @SuppressWarnings("unused")
     public List<RecordsManagementAction> getDispositionActions(NodeRef nodeRef)
@@ -218,7 +221,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#getDispositionActionDefinitions()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#getDispositionActions()
      */
     public List<RecordsManagementAction> getDispositionActions()
     {
@@ -227,7 +230,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
         return Collections.unmodifiableList(result);
     }
 
-    /*
+    /**
      * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#getDispositionAction(java.lang.String)
      */
     public RecordsManagementAction getDispositionAction(String name)
@@ -235,7 +238,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
         return dispositionActions.get(name);
     }
 
-    /*
+    /**
      * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#getRecordsManagementAction(java.lang.String)
      */
     public RecordsManagementAction getRecordsManagementAction(String name)
@@ -244,7 +247,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
      */
     public RecordsManagementActionResult executeRecordsManagementAction(NodeRef nodeRef, String name)
     {
@@ -252,7 +255,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#executeRecordsManagementAction(java.util.List, java.lang.String)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#executeRecordsManagementAction(java.util.List, java.lang.String)
      */
     public Map<NodeRef, RecordsManagementActionResult> executeRecordsManagementAction(List<NodeRef> nodeRefs, String name)
     {
@@ -260,7 +263,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#executeRecordsManagementAction(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map)
      */
     public RecordsManagementActionResult executeRecordsManagementAction(NodeRef nodeRef, String name, Map<String, Serializable> parameters)
     {
@@ -294,7 +297,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#executeRecordsManagementAction(java.lang.String, java.util.Map)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#executeRecordsManagementAction(java.lang.String, java.util.Map)
      */
     public RecordsManagementActionResult executeRecordsManagementAction(String name, Map<String, Serializable> parameters)
     {
@@ -317,7 +320,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementActionService#executeRecordsManagementAction(java.util.List, java.lang.String, java.util.Map)
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService#executeRecordsManagementAction(java.util.List, java.lang.String, java.util.Map)
      */
     public Map<NodeRef, RecordsManagementActionResult> executeRecordsManagementAction(List<NodeRef> nodeRefs, String name, Map<String, Serializable> parameters)
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/constraint/CustomParameterConstraint.java

@@ -35,39 +35,40 @@ import org.alfresco.repo.action.constraint.BaseParameterConstraint;
 
 /**
  * A parameter constraint that reads in a list of allowable values from Spring configuration
- * 
+ *
  * @author Craig Tan
  * @since 2.1
  */
 public class CustomParameterConstraint extends BaseParameterConstraint
 {
-    
     private List<String> parameterValues;
 
     /**
-     * @param parameterValues
+     * Sets the parameter values
+     *
+     * @param parameterValues The parameter values
      */
     public void setParameterValues(List<String> parameterValues)
     {
         this.parameterValues = parameterValues;
     }
-    
+
     /**
      * @see org.alfresco.service.cmr.action.ParameterConstraint#getAllowableValues()
      */
     protected Map<String, String> getAllowableValuesImpl()
-    {                  
+    {
         Map<String, String> allowableValues = new HashMap<String, String>(parameterValues.size());
-        
+
         for (Object parameterValue : parameterValues)
         {
             // Look up the I18N value
             String displayLabel = getI18NLabel(parameterValue.toString());
-            
+
             // Add to the map of allowed values
             allowableValues.put(parameterValue.toString(), displayLabel);
-        } 
+        }
-        
+
         return allowableValues;
     }
 }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/dm/MoveDmRecordAction.java

@@ -98,7 +98,7 @@ public class MoveDmRecordAction extends AuditableActionExecuterAbstractBase impl
     /**
      * Sets the inplace record service
      *
-     * @param InplaceRecordService Inplace record service
+     * @param inplaceRecordService Inplace record service
      */
     public void setInplaceRecordService(InplaceRecordService inplaceRecordService)
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/evaluator/DelegateActionCondition.java

@@ -36,11 +36,11 @@ import org.alfresco.service.cmr.action.ParameterDefinition;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
- * Records management action condition who's implementation is delegated to an existing 
+ * Records management action condition who's implementation is delegated to an existing
  * action condition.
  * <p>
  * Useful for creating a RM version of an existing action condition implementation.
- * 
+ *
  * @author Roy Wetherall
  * @since 2.1
  */
@@ -48,9 +48,11 @@ public class DelegateActionCondition extends RecordsManagementActionConditionEva
 {
     /** Delegate action evaluator */
     private ActionConditionEvaluator actionConditionEvaluator;
-    
+
     /**
-     * @param actionEvaluator   action evaluator
+     * Sets the action condition evaluator
+     *
+     * @param actionConditionEvaluator The action condition evaluator
      */
     public void setActionConditionEvaluator(ActionConditionEvaluator actionConditionEvaluator)
     {
@@ -62,10 +64,10 @@ public class DelegateActionCondition extends RecordsManagementActionConditionEva
      */
     @Override
     protected boolean evaluateImpl(ActionCondition actionCondition, NodeRef actionedUponNodeRef)
-    {        
+    {
         return actionConditionEvaluator.evaluate(actionCondition, actionedUponNodeRef);
     }
-    
+
     /**
      * @see org.alfresco.repo.action.ParameterizedItemAbstractBase#getParameterDefintions()
      */

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/evaluator/HasDispositionActionEvaluator.java

@@ -63,7 +63,9 @@ public class HasDispositionActionEvaluator extends RecordsManagementActionCondit
     private DispositionService dispositionService;
 
     /**
-     * @param dispositionService
+     * Sets the disposition service
+     *
+     * @param dispositionService The disposition service
      */
     public void setDispositionService(DispositionService dispositionService)
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/evaluator/IsRecordTypeEvaluator.java

@@ -39,11 +39,9 @@ import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.namespace.QName;
 
-
-
 /**
  * Records management IsRecordType evaluator that evaluates whether the record is of the specified type.
- * 
+ *
  * @author Craig Tan
  * @since 2.1
  */
@@ -62,7 +60,9 @@ public class IsRecordTypeEvaluator extends RecordsManagementActionConditionEvalu
     private NodeService nodeService;
 
     /**
-     * @param nodeService
+     * Sets the node service
+     *
+     * @param nodeService The node service
      */
     public void setNodeService(NodeService nodeService)
     {

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/impl/ApplyCustomTypeAction.java

@@ -91,8 +91,7 @@ public class ApplyCustomTypeAction extends RMActionExecuterAbstractBase
     }
 
     /**
-     * This method extracts the properties from the custom type's aspect.
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RMActionExecuterAbstractBase#addParameterDefinitions(java.util.List)
-     * @see #getCustomTypeAspect()
      */
     @Override
     protected final void addParameterDefinitions(List<ParameterDefinition> paramList)

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/impl/DestroyAction.java

@@ -56,10 +56,10 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
 
     /** content destruction component */
     private ContentDestructionComponent contentDestructionComponent;
-    
+
     /** Capability service */
     private CapabilityService capabilityService;
-    
+
     /** Recordable version service */
     private RecordableVersionService recordableVersionService;
 
@@ -73,7 +73,7 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
     {
         this.contentDestructionComponent = contentDestructionComponent;
     }
-    
+
     /**
      * @param capabilityService capability service
      */
@@ -81,7 +81,7 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
     {
         this.capabilityService = capabilityService;
     }
-    
+
     /**
      * @param recordableVersionService  recordable version service
      */
@@ -99,7 +99,7 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
     }
 
     /**
-     * @see org.alfresco.module.org_alfresco_module_rm.action.RMDispositionActionExecuterAbstractBase#checkNextDispositionAction()
+     * @see org.alfresco.module.org_alfresco_module_rm.action.RMDispositionActionExecuterAbstractBase#checkNextDispositionAction(org.alfresco.service.cmr.repository.NodeRef)
      */
     @Override
     protected boolean checkNextDispositionAction(NodeRef actionedUponNodeRef)
@@ -159,7 +159,7 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
      */
     @Override
     protected void executeRecordLevelDisposition(Action action, NodeRef record)
-    {        
+    {
         if (isGhostOnDestroySetForAction(action, record))
         {
             // mark version as destroyed
@@ -168,10 +168,10 @@ public class DestroyAction extends RMDispositionActionExecuterAbstractBase
             {
                 recordableVersionService.destroyRecordedVersion(version);
             }
-            
+
             // Add the ghosted aspect
             getNodeService().addAspect(record, ASPECT_GHOSTED, null);
-            
+
             // destroy content
             contentDestructionComponent.destroyContent(record);
         }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/impl/TransferAction.java

@@ -52,7 +52,7 @@ public class TransferAction extends RMDispositionActionExecuterAbstractBase
     /**
      * Indicates whether this transfer is an accession or not
      *
-     * @param isAccession
+     * @param isAccession Is the transfer an accession or not
      */
     public void setIsAccession(boolean isAccession)
     {
@@ -60,6 +60,8 @@ public class TransferAction extends RMDispositionActionExecuterAbstractBase
     }
 
     /**
+     * Sets the transfer service
+     *
      * @param transferService transfer service
      */
     public void setTransferService(TransferService transferService)

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java

@@ -62,7 +62,7 @@ public interface RecordsManagementAdminService
     /**
      * Get a list of all registered customisable types and aspects.
      *
-     * @return	{@link Set}<{@link QName}> QName's of customisable types and aspects
+     * @return Set of <{@link QName}>s of customisable types and aspects
      */
     Set<QName> getCustomisable();
 
@@ -71,7 +71,7 @@ public interface RecordsManagementAdminService
      * node reference.
      *
      * @param nodeRef  node reference
-     * @return {@link Set}<{@link QName}> QName's of customisable types and aspects, empty if none
+     * @return Set of <{@link QName}>s of customisable types and aspects, empty if none
      */
     Set<QName> getCustomisable(NodeRef nodeRef);
 
@@ -108,13 +108,13 @@ public interface RecordsManagementAdminService
     /**
      * This method returns the custom properties that have been defined for the specified
      * customisable RM element.
-     * <P/>
+     * <p>
      * Note: the custom property definitions are retrieved from the dictionaryService
      * which is notified of any newly created definitions on transaction commit.
      * Therefore custom properties created in the current transaction will not appear
      * in the result of this method.
      *
-     * @param customisedElement
+     * @param customisableType
      * @return
      * @see CustomisableRmElement
      */