From d8ab355a0520c7eee20a321af3da197e021d5585 Mon Sep 17 00:00:00 2001
From: Tuna Aksoy <tuna.aksoy@alfresco.com>
Date: Tue, 13 Nov 2012 15:53:53 +0000
Subject: [PATCH] FreezeService code refactoring

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@43578 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 .../rm-capabilities-condition-context.xml     |  1 +
 .../rm-ui-evaluators-context.xml              |  1 +
 .../RecordsManagementService.java             |  7 ++++
 .../AbstractCapabilityCondition.java          | 10 +++++
 .../condition/FrozenCapabilityCondition.java  |  4 +-
 .../condition/FrozenOrHoldCondition.java      |  2 +-
 .../freeze/FreezeService.java                 | 17 +++++++++
 .../freeze/FreezeServiceImpl.java             | 37 ++++++++++++++++++-
 .../jscript/app/BaseEvaluator.java            | 12 ++++++
 .../app/evaluator/FrozenEvaluator.java        |  2 +-
 10 files changed, 87 insertions(+), 6 deletions(-)

diff --git a/rm-server/config/alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-condition-context.xml b/rm-server/config/alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-condition-context.xml
index 3c8fc8f4e9..fa32d07589 100644
--- a/rm-server/config/alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-condition-context.xml
+++ b/rm-server/config/alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-condition-context.xml
@@ -10,6 +10,7 @@
 		<property name="recordsManagementService" ref="recordsManagementService" />
 		<property name="permissionService" ref="PermissionService" />    
 		<property name="nodeService" ref="NodeService" />
+		<property name="freezeService" ref="freezeService" />
     </bean>
     
     <bean id="capabilityCondition.frozen" 
diff --git a/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-ui-evaluators-context.xml b/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-ui-evaluators-context.xml
index 72a35ea07a..133bf8bc76 100644
--- a/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-ui-evaluators-context.xml
+++ b/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-ui-evaluators-context.xml
@@ -17,6 +17,7 @@
 	    <property name="nodeService" ref="NodeService"/>
 	    <property name="namespaceService" ref="NamespaceService"/>
 	    <property name="capabilityService" ref="CapabilityService"/>
+	    <property name="freezeService" ref="freezeService"/>
 	</bean>
 	
 	<bean id="jsonConversionComponent.baseIndicator" 
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/RecordsManagementService.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/RecordsManagementService.java
index 3d25fb2bfe..940591a55d 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/RecordsManagementService.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/RecordsManagementService.java
@@ -23,6 +23,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
 import org.alfresco.module.org_alfresco_module_rm.record.RecordService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
@@ -150,7 +151,10 @@ public interface RecordsManagementService
      * @return  boolean     true if record is frozen, false otherwise
      * 
      * @since 2.0
+     *
+     * @deprecated As of 2.1, replaced by {@link FreezeService#isFrozen(NodeRef)}
      */
+    @Deprecated 
     boolean isFrozen(NodeRef nodeRef);
     
     
@@ -164,7 +168,10 @@ public interface RecordsManagementService
      * @return boolean  true if record folder has frozen children, false otherwise
      * 
      * @since 2.0
+     * 
+     * @deprecated As of 2.1, replaced by {@link FreezeService#hasFrozenChildren(NodeRef)}
      */
+    @Deprecated
     boolean hasFrozenChildren(NodeRef nodeRef);    
     
     /**
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/AbstractCapabilityCondition.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/AbstractCapabilityCondition.java
index f09769a026..5ace4d7a7e 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/AbstractCapabilityCondition.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/AbstractCapabilityCondition.java
@@ -19,6 +19,7 @@
 package org.alfresco.module.org_alfresco_module_rm.capability.declarative;
 
 import org.alfresco.module.org_alfresco_module_rm.RecordsManagementService;
+import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.cmr.security.PermissionService;
@@ -40,6 +41,7 @@ public abstract class AbstractCapabilityCondition implements CapabilityCondition
     protected RecordsManagementService rmService;
     protected PermissionService permissionService;
     protected NodeService nodeService;
+    protected FreezeService freezeService;
     
     /**
      * @param rmService records management service
@@ -65,6 +67,14 @@ public abstract class AbstractCapabilityCondition implements CapabilityCondition
         this.nodeService = nodeService;
     }
     
+    /**
+     * @param freezeService   freeze service
+     */
+    public void setFreezeService(FreezeService freezeService)
+    {
+       this.freezeService = freezeService;
+    }
+    
     /**
      * @see org.alfresco.module.org_alfresco_module_rm.capability.declarative.CapabilityCondition#getName()
      */
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenCapabilityCondition.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenCapabilityCondition.java
index 11d74e4d63..4dcf1c302f 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenCapabilityCondition.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenCapabilityCondition.java
@@ -36,10 +36,10 @@ private boolean checkChildren = false;
     @Override
     public boolean evaluate(NodeRef nodeRef)
     {
-        boolean result = rmService.isFrozen(nodeRef);
+        boolean result = freezeService.isFrozen(nodeRef);
         if (result == false && checkChildren == true)
         {
-            result = rmService.hasFrozenChildren(nodeRef);
+            result = freezeService.hasFrozenChildren(nodeRef);
         }
         return result;
     }
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenOrHoldCondition.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenOrHoldCondition.java
index 025f63d9b4..3786738672 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenOrHoldCondition.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/condition/FrozenOrHoldCondition.java
@@ -36,7 +36,7 @@ public class FrozenOrHoldCondition extends AbstractCapabilityCondition
     public boolean evaluate(NodeRef nodeRef)
     {
         FilePlanComponentKind kind = rmService.getFilePlanComponentKind(nodeRef);
-        return (rmService.isFrozen(nodeRef) || 
+        return (freezeService.isFrozen(nodeRef) || 
                 (kind != null && kind.equals(FilePlanComponentKind.HOLD)));
     }
 
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
index 9c8c79f86b..dacbf19a53 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
@@ -136,4 +136,21 @@ public interface FreezeService
      * @param reason    updated reason
      */
     void updateReason(NodeRef hold, String reason);
+
+    /**
+     * Gets the hold node references for a given file plan
+     * or an empty set if there is not any hold node available
+     * 
+     * @param filePlan      file plan for which the hold nodes will be retrieved
+     * @return Set<NodeRef> hold node references
+     */
+    Set<NodeRef> getHolds(NodeRef filePlan);
+
+    /**
+     * Checks whether or not the given node has frozen children
+     * 
+     * @param nodeRef The nodeRef for which will be checked if it has frozen children
+     * @return true   if the given nodeRef has frozen children, false otherwise
+     */
+    boolean hasFrozenChildren(NodeRef nodeRef);
 }
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java
index 1db03c4904..dda6ab853f 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java
@@ -138,7 +138,7 @@ public class FreezeServiceImpl implements FreezeService,
             if (nodeService.exists(nodeRef) == true &&
                      recordsManagementService.isFilePlanComponent(nodeRef) == true)
             {
-               if (recordsManagementService.isFrozen(nodeRef) == true)
+               if (isFrozen(nodeRef) == true)
                {
                   // never allowed to delete a frozen node 
                   throw new AccessDeniedException("Frozen nodes can not be deleted.");
@@ -165,7 +165,7 @@ public class FreezeServiceImpl implements FreezeService,
          if (assoc.isPrimary() == true)
          {
             NodeRef nodeRef = assoc.getChildRef();
-            if (recordsManagementService.isFrozen(nodeRef) == true)
+            if (isFrozen(nodeRef) == true)
             {
                // never allowed to delete a node with a frozen child
                throw new AccessDeniedException("Can not delete node, because it contains a frozen child node.");
@@ -456,6 +456,39 @@ public class FreezeServiceImpl implements FreezeService,
       nodeService.setProperty(hold, PROP_HOLD_REASON, reason);
    }
 
+   /**
+    * @see org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService#getHold(org.alfresco.service.cmr.repository.NodeRef)
+    */
+   @Override
+   public Set<NodeRef> getHolds(NodeRef filePlan)
+   {
+      ParameterCheck.mandatory("filePlan", filePlan);
+
+      Set<NodeRef> holds = new HashSet<NodeRef>();
+
+      List<ChildAssociationRef> childAssocs = nodeService.getChildAssocs(filePlan, ASSOC_HOLDS, RegexQNamePattern.MATCH_ALL);
+      if (childAssocs != null && !childAssocs.isEmpty())
+      {
+         for (ChildAssociationRef childAssoc : childAssocs)
+         {
+            holds.add(childAssoc.getChildRef());
+         }
+      }
+
+      return holds;
+   }
+
+   /**
+    * @see org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService#hasFrozenChildren(org.alfresco.service.cmr.repository.NodeRef)
+    */
+   @Override
+   public boolean hasFrozenChildren(NodeRef nodeRef)
+   {
+      ParameterCheck.mandatory("nodeRef", nodeRef);
+
+      return getFrozen(nodeRef).size() > 0 ? true : false;
+   }
+
    /**
     * Creates a hold using the given nodeRef and reason
     * 
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/BaseEvaluator.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/BaseEvaluator.java
index 014f4ad8e5..a99ca3c036 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/BaseEvaluator.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/BaseEvaluator.java
@@ -27,6 +27,7 @@ import org.alfresco.module.org_alfresco_module_rm.FilePlanComponentKind;
 import org.alfresco.module.org_alfresco_module_rm.RecordsManagementService;
 import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
 import org.alfresco.module.org_alfresco_module_rm.capability.CapabilityService;
+import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
@@ -58,6 +59,9 @@ public abstract class BaseEvaluator implements RecordsManagementModel
     /** Capability service */
     protected CapabilityService capabilityService;
     
+    /** Freeze service */
+    protected FreezeService freezeService;
+    
     /** File plan component kinds */
     protected Set<FilePlanComponentKind> kinds;    
     
@@ -104,6 +108,14 @@ public abstract class BaseEvaluator implements RecordsManagementModel
         this.capabilityService = capabilityService;
     }
     
+    /**
+     * @param freezeService freeze service
+     */
+    public void setFreezeService(FreezeService freezeService)
+    {
+       this.freezeService = freezeService;
+    }
+    
     /**
      * @param name
      */
diff --git a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/evaluator/FrozenEvaluator.java b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/evaluator/FrozenEvaluator.java
index 3159c746b0..fefca5c977 100644
--- a/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/evaluator/FrozenEvaluator.java
+++ b/rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/jscript/app/evaluator/FrozenEvaluator.java
@@ -29,6 +29,6 @@ public class FrozenEvaluator extends BaseEvaluator
     @Override
     protected boolean evaluateImpl(NodeRef nodeRef)
     {
-        return recordsManagementService.isFrozen(nodeRef);
+        return freezeService.isFrozen(nodeRef);
     }
 }