RM-4312: added comments to unit tests

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/BaseBehaviourBean.java

@@ -127,28 +127,14 @@ public abstract class BaseBehaviourBean extends ServiceBaseImpl
     protected void validateNewChildAssociationSubTypesIncluded(NodeRef child, List<QName> acceptedMultipleChildType) throws InvalidParameterException
     {
         QName childType = getInternalNodeService().getType(child);
-        if(!validateNodeRef(acceptedMultipleChildType, childType))
-        {
-            throw new InvalidParameterException("Operation failed. Children of type " + childType + " are not allowed");
-        }
-    }
-
-    /**
-     * Checks if the type of the provided nodeRef it is between the sub-types of accepted types
-     *
-     * @param acceptedMultipleChildType
-     * @param nodeType
-     * @return true if the type of the nodeRef is between the sub-types of accepted types, or false otherwise
-     */
-    protected boolean validateNodeRef(List<QName> acceptedMultipleChildType, QName nodeType)
-    {
         for(QName type :  acceptedMultipleChildType)
         {
-            if(instanceOf(nodeType, type))
+            if(instanceOf(childType, type))
             {
-                return true;
+                return;
             }
         }
-        return false;
+        //no match was found in sub-types of permitted types list
+        throw new InvalidParameterException("Operation failed. Children of type " + childType + " are not allowed");
     }
 }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/FilePlanType.java

@@ -63,8 +63,8 @@ public class FilePlanType extends    BaseBehaviourBean
                                      NodeServicePolicies.OnCreateNodePolicy,
                                      NodeServicePolicies.OnDeleteNodePolicy
 {
-    private static List<QName> ACCEPTED_UNIQUE_CHILD_TYPES = Arrays.asList(TYPE_HOLD_CONTAINER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER);
+    private final static List<QName> ACCEPTED_UNIQUE_CHILD_TYPES = Arrays.asList(TYPE_HOLD_CONTAINER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER);
-    private static List<QName> ACCEPTED_NON_UNIQUE_CHILD_TYPES = Arrays.asList(TYPE_RECORD_CATEGORY);
+    private final static List<QName> ACCEPTED_NON_UNIQUE_CHILD_TYPES = Arrays.asList(TYPE_RECORD_CATEGORY);
 
     /** file plan service */
     private FilePlanService filePlanService;

rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/HoldContainerTypeUnitTest.java

@@ -50,6 +50,10 @@ public class HoldContainerTypeUnitTest extends BaseUnitTest
     /** test object */
     private @InjectMocks HoldContainerType holdContainerType;
 
+    /**
+     * Given that we try to add a non "rma:hold" type to hold container,
+     * Then InvalidParameterException is thrown.
+     */
     @Test (expected = InvalidParameterException.class)
     public void testAddNonHoldTypeToHoldContainer()
     {
@@ -64,6 +68,10 @@ public class HoldContainerTypeUnitTest extends BaseUnitTest
         holdContainerType.onCreateChildAssociation(mockedChildAssoc, true);
     }
 
+    /**
+     * Given that we try to add "rma:hold" type to hold container,
+     * Then the operation is successful.
+     */
     @Test
     public void testAddHoldTypeToHoldContainer()
     {

rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/TransferContainerTypeUnitTest.java

@@ -50,6 +50,10 @@ public class TransferContainerTypeUnitTest extends BaseUnitTest
     /** test object */
     private @InjectMocks TransferContainerType transferContainerType;
 
+    /**
+     * Given that we try to add a non "rma:transfer" type to transfer container,
+     * Then InvalidParameterException is thrown.
+     */
     @Test(expected = InvalidParameterException.class)
     public void testAddNonTransferTypeToTransferContainerTest()
     {
@@ -65,6 +69,10 @@ public class TransferContainerTypeUnitTest extends BaseUnitTest
         transferContainerType.onCreateChildAssociation(mockedChildAssoc, true);
     }
 
+    /**
+     * Given that we try to add "rma:transfer" type to transfer container,
+     * Then the operation is successful.
+     */
     @Test
     public void testAddTransferFolderToTransferContainer()
     {

rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/UnfiledRecordContainerTypeUnitTest.java

@@ -52,6 +52,10 @@ public class UnfiledRecordContainerTypeUnitTest extends BaseUnitTest
     @InjectMocks
     private UnfiledRecordContainerType unfiledRecordContainerType;
 
+    /**
+     * Given that we try to add a type that is not one of "rma:unfiledRecordFolder", "cm:content" or "rma:nonElectronicDocument" types to unfiled record container,
+     * Then InvalidParameterException is thrown.
+     */
     @Test(expected = InvalidParameterException.class)
     public void testAddNonAcceptedTypeToUnfiledRecordContainer()
     {
@@ -69,6 +73,10 @@ public class UnfiledRecordContainerTypeUnitTest extends BaseUnitTest
         unfiledRecordContainerType.onCreateChildAssociation(mockedChildAssoc, true);
     }
 
+    /**
+     * Given that we try to add "rma:unfiledRecordFolder" sub-type to unfiled record container,
+     * Then the operation is successful.
+     */
     @Test
     public void testAddUnfiledRecordFolderTypeToUnfiledRecordContainer()
     {
@@ -86,6 +94,10 @@ public class UnfiledRecordContainerTypeUnitTest extends BaseUnitTest
         unfiledRecordContainerType.onCreateChildAssociation(mockedChildAssoc, true);
     }
 
+    /**
+     * Given that we try to add "cm:content" sub-type to unfiled record container,
+     * Then the operation is successful.
+     */
     @Test
     public void testAddContentTypeToUnfiledRecordContainer()
     {
@@ -103,6 +115,10 @@ public class UnfiledRecordContainerTypeUnitTest extends BaseUnitTest
         unfiledRecordContainerType.onCreateChildAssociation(mockedChildAssoc, true);
     }
 
+    /**
+     * Given that we try to add "rma:nonElectronicDocument" sub-type to unfiled record container,
+     * Then the operation is successful.
+     */
     @Test
     public void testNonElectronicDocumentTypeToUnfiledRecordContainer()
     {